Module sublevel

This API is added by CC: Sable and allows CC: Tweaked computers to access information from Sable Sub-Levels.

This library also includes CC: Advanced Math which provides the quaternion API.

Functions

isInPlotGrid () Determines whether the computer is currently on a Sub-Level.
getUniqueId () Gets the Sub-Level's Universally Unique Identifier (UUID).
getName () Gets the Sub-Level's name.
getLogicalPose () Gets the Sub-Level's logical pose of the Sub-Level.
getLastPose () Gets the Sub-Level's last pose of the Sub-Level.
getVelocity () Gets the Sub-Level's global velocity.


Functions

isInPlotGrid ()
Determines whether the computer is currently on a Sub-Level.

Returns:

    boolean true if the computer is on a Sub-Level, false otherwise
getUniqueId ()
Gets the Sub-Level's Universally Unique Identifier (UUID).

Returns:

    string The Sub-Level UUID

Raises:

This method errors if there is no Sub-Level associated with the computer.
getName ()
Gets the Sub-Level's name.

Returns:

    string The Sub-Level name

Raises:

This method errors if there is no Sub-Level associated with the computer.
getLogicalPose ()
Gets the Sub-Level's logical pose of the Sub-Level.

Returns:

    table Pose information including position, orientation, scale, and rotation point

Raises:

This method errors if there is no Sub-Level associated with the computer.
getLastPose ()
Gets the Sub-Level's last pose of the Sub-Level.

Returns:

    table Pose information including position, orientation, scale, and rotation point

Raises:

This method errors if there is no Sub-Level associated with the computer.
getVelocity ()
Gets the Sub-Level's global velocity.

Returns:

    vector the global velocity of the Sub-Level

Raises:

This method errors if there is no Sub-Level associated with the computer.
generated by LDoc 1.5.0 Last updated 2026-03-03 04:57:50