Skip to main content
Many functions within the cheat table are designed to operate exclusively on a specific class of game Instance (e.g., set_ambient only works on a Lighting Instance). You are responsible for ensuring that the Instance you pass as an argument is of the correct class type before calling the function. Passing an incorrect Instance type will lead to undefined behavior, errors, or application crashes.
For rapid identification, reading an Instance’s Class Name (get_class) is highly recommended over reading its user-defined Name (get_name). get_class requires only one low-level memory read per Instance, offering significantly better performance and should be the preferred method for filtering and iteration in your scripts.

​
Access

All cheat C++ functions are exposed to your Lua script via a single global table named cheat. You access individual values by using the dot (.) or bracket ([]) operator on this table.
Cheat Usage Example
local Instance_name = cheat.get_name(Instance); -- Dot Operator
cheat["set_field_of_view"](camera, 20); -- Bracket Operator

​
Functions

This section lists all available C++ functions exposed within the global cheat table. These functions provide high-level manipulation and access to environment, game state, and object properties.

​
Misc

This section contains miscellaneous utility functions, primarily for coordinate system conversions like transforming 3D world coordinates to 2D screen points.

​
world_to_point

Converts a 3D world position to a 2D screen point. Returns a Point containing the screen position and offscreen state. 
world_to_point(Vector3: value, boolean?: offscreen): Point
​
value
Vector3
required
The 3D world position to convert to screen coordinates.
​
offscreen
boolean
Whether to calculate the position when it’s offscreen. If false, returns a Point with visible set to false when offscreen without calculating the actual position. Defaults to false.

​
Base

This section contains fundamental system functions used to retrieve the base memory addresses (e.g., DataModel, Visual Engine) required for the initialization and operation of most other high-level cheat functions.

​
get_data_model

Gets the current DataModel Instance address. Returns the memory address as a number. 
get_data_model(): number

​
get_render_view

Gets the current Render View address. Returns the memory address as a number. 
get_render_view(): number

​
get_engine

Gets the current Visual Engine address. Returns the memory address as a number. 
get_engine(): number

​
Data Model

This section lists methods that operate directly on the core DataModel Instance. These functions are essential for traversing the game hierarchy, retrieving key services, and accessing global game identification details.

​
get_service

Gets a service from the service list by name. Returns the memory address as a number. 
get_service(string: name): number
​
name
string
required
The name of the service to retrieve (e.g., "Players", "UserInputService").

​
get_workspace

Gets the current Workspace Instance address. Returns the memory address as a number. 
get_workspace(): number

​
get_game_id

Gets the current game’s game ID. Returns the game ID as a number. 
get_game_id(number: address): number
​
address
number
required
The DataModel Instance address.

​
get_place_id

Gets the current game’s place ID. Returns the place ID as a number. 
get_place_id(number: address): number
​
address
number
required
The DataModel Instance address.

​
get_tick

Gets the current game’s tick count. Returns the tick count as a number. 
get_tick(number: address): number
​
address
number
required
The DataModel Instance address.

​
get_job_id

Gets the current game’s job ID. Returns the job ID as a string. Can be called with a DataModel address or without arguments to retrieve the cached job ID. 
get_job_id(number?: address): string
​
address
number
The DataModel Instance address. If not provided, returns the cached job ID.

​
get_version

Gets the target process’s current version. Returns the version string. 
get_version(): string

​
Engine

This section lists methods that operate on the Visual Engine and Render View memory structures. These functions are critical for manipulating low-level rendering properties, such as controlling lighting updates, accessing the current view matrix, and retrieving the in-game time.

​
get_time

Gets the current time from the Visual Engine. Returns the time as a number. 
get_time(number: address): number
​
address
number
required
The Visual Engine address.

​
get_matrix

Gets the view matrix from the Visual Engine. Returns a Matrix4 containing the current view transformation. 
get_matrix(number: address): Matrix4
​
address
number
required
The Visual Engine address.

​
set_lighting_state

Sets the lighting update state for the Render View. Controls whether lighting, sky, or both are updated. 
set_lighting_state(number: address, number: value): void
​
address
number
required
The Render View Instance address.
​
value
number
required
The lighting state value: 0x0 for both lighting and sky updates, 0x100 for sky updates only, or 0x1 for lighting updates only.

​
set_sky_state

Sets the sky update state for the Render View. Should be called after writing to skybox along with set_lighting_state. 
set_sky_state(number: address, boolean: value): void
​
address
number
required
The Render View Instance address.
​
value
boolean
required
The sky state value. Set to false to trigger sky updates.

​
Fast Flags

This section lists methods specifically for interacting with Fast Flags (FFlags). These functions allow you to dynamically read and write internal, experimental, or configuration variables used by the game engine to control features and behavior at runtime.

​
set_fflag

Sets a Fast Flag (FFlag) value by name. Returns true if the flag was successfully set, false otherwise. 
set_fflag(string: name, boolean | number: value): boolean
​
name
string
required
The name of the Fast Flag to set.
​
value
boolean | number
required
The value to set the flag to. Accepts boolean or number types. String support coming in the future.

​
Instance

This section provides methods for inspecting, traversing, and manipulating any valid Instance within the DataModel hierarchy, including retrieving, setting, and validating its core properties.

​
get_class

Gets the class name of an Instance. Returns the class name as a string. 
get_class(number: address): string
​
address
number
required
The Instance address to get the class name from.

​
get_parent

Gets the parent Instance of an Instance. Returns the parent Instance address as a number. 
get_parent(number: address): number
​
address
number
required
The Instance address to get the parent from.

​
get_name

Gets the name of an Instance. Returns the name as a string. 
get_name(number: address): string
​
address
number
required
The Instance address to get the name from.

​
get_children

Gets the children of an Instance. Returns the children as a table. 
get_children(number: address, number?: amount): table
​
address
number
required
The Instance address to get the children from.
​
amount
number
The amount of children to get. Defaults to 0 aka infinite.

​
get_children_last

Gets the last children of an Instance. Returns the children as a table. 
get_children_last(number: address, number?: amount): table
​
address
number
required
The Instance address to get the children from.
​
amount
number
The amount of children to get. Defaults to 0 aka infinite.

​
get_children_name

Gets the children of an Instance with a specific name. Returns the children as a table. 
get_children_name(number: address, string: name): table
​
address
number
required
The Instance address to get the children from.
​
name
string
required
The specific name to look for in the children.

​
get_child

Gets the first child of an Instance. Returns the child as a number. 
get_child(number: address): number
​
address
number
required
The Instance address to get the child from.

​
get_last_child

Gets the last child of an Instance. Returns the child as a number. 
get_last_child(number: address): number
​
address
number
required
The Instance address to get the child from.

​
get_both_children

Gets both first and last children of an Instance. Returns the children as a table. 
get_both_children(number: address): table
​
address
number
required
The Instance address to get the children from.

​
find_first_child

Gets the first child of an Instance with a specific name. Returns the Instance as a number. 
find_first_child(number: address, string: name): number
​
address
number
required
The Instance address to get the Instance from.
​
name
string
required
The specific name to look for in the children.

​
find_first_class

Gets the first child of an Instance with a specific class name. Returns the Instance as a number. 
find_first_class(number: address, string: name): number
​
address
number
required
The Instance address to get the Instance from.
​
name
string
required
The specific class name to look for in the children.

​
find_last_child

Gets the last child of an Instance with a specific name. Returns the Instance as a number. 
find_last_child(number: address, string: name, number?: amount): number
​
address
number
required
The Instance address to get the Instance from.
​
name
string
required
The specific name to look for in the children.
​
amount
number
The amount of children to get. Defaults to 100.

​
has_children

Checks if an Instance has any children. Returns true if it has any children, false otherwise. 
has_children(number: address): boolean
​
address
number
required
The Instance address to check if it has children from.

​
get_attributes

Gets the attributes of an Instance. Returns the parsed attributes as a table. 
get_attributes(number: address): table
​
address
number
required
The Instance address to get the attributes from.

​
get_attribute

Gets the attribute with of an Instance with a specific name. Returns the parsed attribute as a ParsedAttribute. 
get_attribute(number: address, string: name): ParsedAttribute
​
address
number
required
The Instance address to get the attribute from.
​
name
string
required
The specific name to look for in the attributes.

​
is_base_part

Checks if an class name is a base part. Returns true if it is a base part, false otherwise. 
is_base_part(string: name): boolean
​
name
string
required
The class name to check if it is a base part.

​
is_gui_object

Checks if an class name is a gui object. Returns true if it is a gui object, false otherwise. 
is_gui_object(string: name): boolean
​
name
string
required
The class name to check if it is a gui object.

​
set_parent

Sets the parent Instance of an Instance. 
set_parent(number: address, number: value): void
​
value
number
required
The Instance parent value to set.

​
Workspace

This section provides methods for inspecting, traversing, and manipulating the properties and children specifically contained within the core Workspace Instance of the game environment.

​
get_camera

Gets the current camera Instance. Returns the camera as a number. Can be called with a Workspace address or without arguments to retrieve the cached camera. 
get_camera(number?: address): number
​
address
number
The Workspace Instance address. If not provided, returns the cached current camera.

​
get_terrain

Gets the terrain Instance. Returns the terrain as a number. Can be called with a Workspace address or without arguments to retrieve the cached terrain. 
get_terrain(number?: address): number
​
address
number
The Workspace Instance address. If not provided, returns the cached terrain.

​
Camera

This section provides methods for inspecting and manipulating the Camera Instance’s properties, including its position, orientation, field of view, and various movement behaviors.

​
get_camera_subject

Gets the current camera subject Instance of the Camera Instance. Returns the camera subject Instance address as a number. 
get_camera_subject(number: address): number
​
address
number
required
The Camera Instance address.

​
get_camera_rotation

Gets the rotation matrix of the Camera Instance. Returns a Matrix3 containing the camera’s rotation. 
get_camera_rotation(number: address): Matrix3
​
address
number
required
The Camera Instance address.

​
get_camera_translation

Gets the translation (position) of the Camera Instance. Returns a Vector3 containing the camera’s position. 
get_camera_translation(number: address): Vector3
​
address
number
required
The Camera Instance address.

​
get_camera_cframe

Gets the CFrame (coordinate frame) of the Camera Instance. Returns a CFrame containing the camera’s position and orientation. 
get_camera_cframe(number: address): CFrame
​
address
number
required
The Camera Instance address.

​
get_field_of_view

Gets the field of view of the Camera Instance. Returns the field of view in degrees as a number. 
get_field_of_view(number: address): number
​
address
number
required
The Camera Instance address.

​
set_camera_subject

Sets the camera subject Instance of the Camera Instance. 
set_camera_subject(number: address, number: value): void
​
address
number
required
The Camera Instance address.
​
value
number
required
The Instance address to set as the camera subject.

​
set_camera_rotation

Sets the rotation matrix of the Camera Instance. 
set_camera_rotation(number: address, Matrix3: value): void
​
address
number
required
The Camera Instance address.
​
value
Matrix3
required
The rotation matrix to set for the camera.

​
set_camera_translation

Sets the translation (position) of the Camera Instance. 
set_camera_translation(number: address, Vector3: value): void
​
address
number
required
The Camera Instance address.
​
value
Vector3
required
The position vector to set for the camera.

​
set_camera_cframe

Sets the CFrame (coordinate frame) of the Camera Instance. 
set_camera_cframe(number: address, CFrame: value): void
​
address
number
required
The Camera Instance address.
​
value
CFrame
required
The CFrame to set for the camera’s position and orientation.

​
set_field_of_view

Sets the field of view of the Camera Instance. 
set_field_of_view(number: address, number: value): void
​
address
number
required
The Camera Instance address.
​
value
number
required
The field of view in degrees to set for the camera.

​
Terrain

This section provides methods for inspecting and manipulating various environmental and rendering properties of the Terrain instance, including water color, reflection, wave dynamics, and decorative element sizes.

​
get_water_color

Gets the water color of the Terrain Instance. Returns a Color3 containing the water color. 
get_water_color(number: address): Color3
​
address
number
required
The Terrain Instance address.

​
get_grass_size

Gets the grass size of the Terrain Instance. Returns the grass size as a number. 
get_grass_size(number: address): number
​
address
number
required
The Terrain Instance address.

​
get_water_reflect

Gets the water reflectance of the Terrain Instance. Returns the reflectance value as a number. 
get_water_reflect(number: address): number
​
address
number
required
The Terrain Instance address.

​
get_wave_size

Gets the water wave size of the Terrain Instance. Returns the wave size as a number. 
get_wave_size(number: address): number
​
address
number
required
The Terrain Instance address.

​
get_wave_speed

Gets the water wave speed of the Terrain Instance. Returns the wave speed as a number. 
get_wave_speed(number: address): number
​
address
number
required
The Terrain Instance address.

​
get_decoration

Gets the decoration state of the Terrain Instance. Returns true if decoration (grass) is enabled, false otherwise. 
get_decoration(number: address): boolean
​
address
number
required
The Terrain Instance address.

​
set_water_color

Sets the water color of the Terrain Instance. 
set_water_color(number: address, Color3: value): void
​
address
number
required
The Terrain Instance address.
​
value
Color3
required
The Color3 value to set for the water color.

​
set_grass_size

Sets the grass size of the Terrain Instance. 
set_grass_size(number: address, number: value): void
​
address
number
required
The Terrain Instance address.
​
value
number
required
The grass size to set.

​
set_water_reflect

Sets the water reflectance of the Terrain Instance. 
set_water_reflect(number: address, number: value): void
​
address
number
required
The Terrain Instance address.
​
value
number
required
The reflectance value to set for the water.

​
set_wave_size

Sets the water wave size of the Terrain Instance. 
set_wave_size(number: address, number: value): void
​
address
number
required
The Terrain Instance address.
​
value
number
required
The wave size to set for the water.

​
set_wave_speed

Sets the water wave speed of the Terrain Instance. 
set_wave_speed(number: address, number: value): void
​
address
number
required
The Terrain Instance address.
​
value
number
required
The wave speed to set for the water.

​
set_decoration

Sets the decoration state of the Terrain Instance. When set to false, grass will be disabled. 
set_decoration(number: address, boolean: value): void
​
address
number
required
The Terrain Instance address.
​
value
boolean
required
Set to true to enable decoration (grass), false to disable it.

​
Players

This section provides methods for managing and querying the game’s player collection, including retrieving the local client player instance and the maximum number of players allowed in the game.

​
get_client

Gets the local player Instance from the Players service. Returns the local player Instance address as a number. 
get_client(number: address): number
​
address
number
required
The Players service Instance address.

​
get_max_players

Gets the maximum number of players that can be in the server. Returns the max player count as a number. 
get_max_players(number: address): number
​
address
number
required
The Players service Instance address.

​
Lighting

This section provides methods for inspecting and manipulating the Lighting instance’s extensive properties, controlling the visual atmosphere, including ambient and directional light, shadows, fog, exposure, and the addresses of associated sky and atmosphere objects.

​
get_ambient

Gets the ambient lighting color of the Lighting Instance. Returns a Color3 containing the ambient color. 
get_ambient(number: address): Color3
​
address
number
required
The Lighting Instance address.

​
get_shift_bottom

Gets the color shift for the bottom of the skybox in the Lighting Instance. Returns a Color3 containing the bottom shift color. 
get_shift_bottom(number: address): Color3
​
address
number
required
The Lighting Instance address.

​
get_shift_top

Gets the color shift for the top of the skybox in the Lighting Instance. Returns a Color3 containing the top shift color. 
get_shift_top(number: address): Color3
​
address
number
required
The Lighting Instance address.

​
get_fog_color

Gets the fog color of the Lighting Instance. Returns a Color3 containing the fog color. 
get_fog_color(number: address): Color3
​
address
number
required
The Lighting Instance address.

​
get_outdoor_ambient

Gets the outdoor ambient lighting color of the Lighting Instance. Returns a Color3 containing the outdoor ambient color. 
get_outdoor_ambient(number: address): Color3
​
address
number
required
The Lighting Instance address.

​
get_brightness

Gets the brightness level of the Lighting Instance. Returns the brightness as a number. 
get_brightness(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_diffuse_scale

Gets the diffuse scale of the Lighting Instance. Returns the diffuse scale as a number. 
get_diffuse_scale(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_specular_scale

Gets the specular scale of the Lighting Instance. Returns the specular scale as a number. 
get_specular_scale(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_exposure

Gets the exposure level of the Lighting Instance. Returns the exposure as a number. 
get_exposure(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_fog_end

Gets the fog end distance of the Lighting Instance. Returns the fog end distance as a number. 
get_fog_end(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_fog_start

Gets the fog start distance of the Lighting Instance. Returns the fog start distance as a number. 
get_fog_start(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_shadow_softness

Gets the shadow softness of the Lighting Instance. Returns the shadow softness as a number. 
get_shadow_softness(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_technology

Gets the rendering technology mode of the Lighting Instance. Returns the technology mode as a number. 
get_technology(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_global_shadows

Gets the global shadows state of the Lighting Instance. Returns true if global shadows are enabled, false otherwise. 
get_global_shadows(number: address): boolean
​
address
number
required
The Lighting Instance address.

​
get_tint

Gets the color tint of the Lighting Instance. Returns a Color3 containing the tint color. 
get_tint(number: address): Color3
​
address
number
required
The Lighting Instance address.

​
get_direction

Gets the light direction of the Lighting Instance. Returns the direction as a number. 
get_direction(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_sky

Gets the Sky Instance from the Lighting Instance. Returns the Sky Instance address as a number. 
get_sky(number: address): number
​
address
number
required
The Lighting Instance address.

​
get_atmosphere

Gets the Atmosphere Instance from the Lighting Instance. Returns the Atmosphere Instance address as a number. 
get_atmosphere(number: address): number
​
address
number
required
The Lighting Instance address.

​
set_ambient

Sets the ambient lighting color of the Lighting Instance. 
set_ambient(number: address, Color3: value): void
​
address
number
required
The Lighting Instance address.
​
value
Color3
required
The Color3 value to set for the ambient color.

​
set_shift_bottom

Sets the color shift for the bottom of the skybox in the Lighting Instance. 
set_shift_bottom(number: address, Color3: value): void
​
address
number
required
The Lighting Instance address.
​
value
Color3
required
The Color3 value to set for the bottom shift color.

​
set_shift_top

Sets the color shift for the top of the skybox in the Lighting Instance. 
set_shift_top(number: address, Color3: value): void
​
address
number
required
The Lighting Instance address.
​
value
Color3
required
The Color3 value to set for the top shift color.

​
set_fog_color

Sets the fog color of the Lighting Instance. 
set_fog_color(number: address, Color3: value): void
​
address
number
required
The Lighting Instance address.
​
value
Color3
required
The Color3 value to set for the fog color.

​
set_outdoor_ambient

Sets the outdoor ambient lighting color of the Lighting Instance. 
set_outdoor_ambient(number: address, Color3: value): void
​
address
number
required
The Lighting Instance address.
​
value
Color3
required
The Color3 value to set for the outdoor ambient color.

​
set_brightness

Sets the brightness level of the Lighting Instance. 
set_brightness(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The brightness value to set.

​
set_diffuse_scale

Sets the diffuse scale of the Lighting Instance. 
set_diffuse_scale(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The diffuse scale value to set.

​
set_specular_scale

Sets the specular scale of the Lighting Instance. 
set_specular_scale(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The specular scale value to set.

​
set_exposure

Sets the exposure level of the Lighting Instance. 
set_exposure(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The exposure value to set.

​
set_fog_end

Sets the fog end distance of the Lighting Instance. 
set_fog_end(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The fog end distance to set.

​
set_fog_start

Sets the fog start distance of the Lighting Instance. 
set_fog_start(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The fog start distance to set.

​
set_shadow_softness

Sets the shadow softness of the Lighting Instance. 
set_shadow_softness(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The shadow softness value to set.

​
set_technology

Sets the rendering technology mode of the Lighting Instance. 
set_technology(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The technology mode value to set.

​
set_global_shadows

Sets the global shadows state of the Lighting Instance. 
set_global_shadows(number: address, boolean: value): void
​
address
number
required
The Lighting Instance address.
​
value
boolean
required
Set to true to enable global shadows, false to disable them.

​
set_tint

Sets the color tint of the Lighting Instance. 
set_tint(number: address, Color3: value): void
​
address
number
required
The Lighting Instance address.
​
value
Color3
required
The Color3 value to set for the tint color.

​
set_direction

Sets the light direction of the Lighting Instance. 
set_direction(number: address, number: value): void
​
address
number
required
The Lighting Instance address.
​
value
number
required
The direction value to set.

​
Sky

This section provides a method for inspecting the Sky instance to retrieve its current orientation in the game world.

​
get_sky_orientation

Gets the skybox orientation of the Sky Instance. Returns a Vector3 containing the skybox’s rotation angles. 
get_sky_orientation(number: address): Vector3
​
address
number
required
The Sky Instance address.

​
set_sky_orientation

Sets the skybox orientation of the Sky Instance. 
set_sky_orientation(number: address, Vector3: value): void
​
address
number
required
The Sky Instance address.
​
value
Vector3
required
The rotation angles vector to set for the skybox’s orientation.

​
Atmosphere

This section provides methods for inspecting and manipulating the Atmosphere instance’s properties. These functions control various environmental effects such as light density, color, haze, glare, decay, and positional offset.

​
get_density

Gets the density of the Atmosphere Instance. Returns the density as a number. 
get_density(number: address): number
​
address
number
required
The Atmosphere Instance address.

​
get_offset

Gets the offset of the Atmosphere Instance. Returns the offset as a number. 
get_offset(number: address): number
​
address
number
required
The Atmosphere Instance address.

​
get_atmosphere_color

Gets the color of the Atmosphere Instance. Returns a Color3 containing the atmosphere color. 
get_atmosphere_color(number: address): Color3
​
address
number
required
The Atmosphere Instance address.

​
get_decay

Gets the decay color of the Atmosphere Instance. Returns a Color3 containing the decay color. 
get_decay(number: address): Color3
​
address
number
required
The Atmosphere Instance address.

​
get_glare

Gets the glare intensity of the Atmosphere Instance. Returns the glare as a number. 
get_glare(number: address): number
​
address
number
required
The Atmosphere Instance address.

​
get_haze

Gets the haze intensity of the Atmosphere Instance. Returns the haze as a number. 
get_haze(number: address): number
​
address
number
required
The Atmosphere Instance address.

​
set_density

Sets the density of the Atmosphere Instance. 
set_density(number: address, number: value): void
​
address
number
required
The Atmosphere Instance address.
​
value
number
required
The density value to set.

​
set_offset

Sets the offset of the Atmosphere Instance. 
set_offset(number: address, number: value): void
​
address
number
required
The Atmosphere Instance address.
​
value
number
required
The offset value to set.

​
set_atmosphere_color

Sets the color of the Atmosphere Instance. 
set_atmosphere_color(number: address, Color3: value): void
​
address
number
required
The Atmosphere Instance address.
​
value
Color3
required
The Color3 value to set for the atmosphere color.

​
set_decay

Sets the decay color of the Atmosphere Instance. 
set_decay(number: address, Color3: value): void
​
address
number
required
The Atmosphere Instance address.
​
value
Color3
required
The Color3 value to set for the decay color.

​
set_glare

Sets the glare intensity of the Atmosphere Instance. 
set_glare(number: address, number: value): void
​
address
number
required
The Atmosphere Instance address.
​
value
number
required
The glare value to set.

​
set_haze

Sets the haze intensity of the Atmosphere Instance. 
set_haze(number: address, number: value): void
​
address
number
required
The Atmosphere Instance address.
​
value
number
required
The haze value to set.

​
Player

This section provides methods for inspecting and manipulating individual Player instances. These functions allow access to player-specific details such as their display name, team, user ID, account age, character instance, and client properties like camera zoom and idle time.

​
get_display

Gets the display name of the Player Instance. Returns the display name as a string. 
get_display(number: address): string
​
address
number
required
The Player Instance address.

​
get_team

Gets the Team Instance that the Player belongs to. Returns the Team Instance address as a number. 
get_team(number: address): number
​
address
number
required
The Player Instance address.

​
get_user_id

Gets the user ID of the Player Instance. Returns the user ID as a number. 
get_user_id(number: address): number
​
address
number
required
The Player Instance address.

​
get_account_age

Gets the account age (in days) of the Player Instance. Returns the account age as a number. 
get_account_age(number: address): number
​
address
number
required
The Player Instance address.

​
get_camera_zoom

Gets the camera zoom settings of the local Player Instance. Returns a table containing the camera zoom configuration. This function only works for the local player. 
get_camera_zoom(number: address): table
​
address
number
required
The local Player Instance address.

​
get_character

Gets the Character model Instance of the Player. Returns the Character Instance address as a number. 
get_character(number: address): number
​
address
number
required
The Player Instance address.

​
get_idle_time

Gets the idle time (in seconds) of the local Player Instance. Returns the idle time as a number. This function only works for the local player. 
get_idle_time(number: address): number
​
address
number
required
The local Player Instance address.

​
set_camera_zoom

Sets the camera zoom settings of the local Player Instance. This function only works for the local player. 
set_camera_zoom(number: address, table: value): void
​
address
number
required
The local Player Instance address.
​
value
table
required
A table containing the camera zoom configuration to set.

​
set_idle_time

Sets the idle time (in seconds) of the local Player Instance. This function only works for the local player. 
set_idle_time(number: address, number: value): void
​
address
number
required
The local Player Instance address.
​
value
number
required
The idle time in seconds to set.

​
Team

This section provides methods for inspecting and manipulating individual Team instances, including properties like color and name.

​
get_team_color

Gets the BrickColor team color ID of the Team Instance. Returns the BrickColor ID as a number. Use fromBrickColor on a Color3 or Color4 to convert this to a Color value. 
get_team_color(number: address): number
​
address
number
required
The Team Instance address.

​
Model

This section provides a method for inspecting the Model instance to retrieve a reference to its designated primary or root part.

​
get_primary_part

Gets the PrimaryPart BasePart Instance of the Model Instance. Returns the PrimaryPart Instance address as a number. 
get_primary_part(number: address): number
​
address
number
required
The Model Instance address.

​
Base Part

This section provides methods for inspecting and manipulating properties common to all BasePart derivatives (e.g., Part, MeshPart, UnionOperation). These functions control aspects like transparency, retrieving primitive, and visual appearance.

​
get_transparency

Gets the transparency value of the BasePart Instance. Returns the transparency as a number (0 is fully opaque, 1 is fully transparent). 
get_transparency(number: address): number
​
address
number
required
The BasePart Instance address.

​
get_primitive

Gets the Primitive Class of the BasePart. Returns the Primitive Class address as a number. 
get_primitive(number: address): number
​
address
number
required
The BasePart Instance address.

​
get_part_color

Gets the color of the BasePart Instance. Returns a Color3 containing the part’s color. 
get_part_color(number: address): Color3
​
address
number
required
The BasePart Instance address.

​
Primitive

This section provides methods for inspecting and manipulating the core physical and spatial properties of a BasePart’s associated Primitive class. These functions control essential data like its CFrame, size, rotation, velocity, and fundamental physics behaviors such as gravity and collision.

​
get_gravity

Gets the world gravity of the Primitive Instance. Returns the world multiplier as a number. 
get_gravity(number: address): number
​
address
number
required
The Primitive Instance address.

​
get_rotation

Gets the rotation matrix of the Primitive Instance. Returns a Matrix3 containing the primitive’s rotation. 
get_rotation(number: address): Matrix3
​
address
number
required
The Primitive Instance address.

​
get_translation

Gets the translation (position) of the Primitive Instance. Returns a Vector3 containing the primitive’s position. 
get_translation(number: address): Vector3
​
address
number
required
The Primitive Instance address.

​
get_cframe

Gets the CFrame (coordinate frame) of the Primitive Instance. Returns a CFrame containing the primitive’s position and orientation. 
get_cframe(number: address): CFrame
​
address
number
required
The Primitive Instance address.

​
get_velocity

Gets the velocity of the Primitive Instance. Returns a Vector3 containing the primitive’s velocity. 
get_velocity(number: address): Vector3
​
address
number
required
The Primitive Instance address.

​
get_size

Gets the size of the Primitive Instance. Returns a Vector3 containing the part’s dimensions. 
get_size(number: address): Vector3
​
address
number
required
The Primitive Instance address.

​
get_prim_parent

Gets the BasePart Instance that this Primitive belongs to. Returns the BasePart Instance address as a number. 
get_prim_parent(number: address): number
​
address
number
required
The Primitive Instance address.

​
get_collision

Gets the collision bitmask value of the Primitive Instance. Returns the collision bitmask value as a number. 
get_collision(number: address): number
​
address
number
required
The Primitive Instance address.

​
set_gravity

Sets the gravity multiplier of the Primitive Instance. 
set_gravity(number: address, number: value): void
​
address
number
required
The Primitive Instance address.
​
value
number
required
The world gravity to set.

​
set_rotation

Sets the rotation matrix of the Primitive Instance. 
set_rotation(number: address, Matrix3: value): void
​
address
number
required
The Primitive Instance address.
​
value
Matrix3
required
The rotation matrix to set for the primitive.

​
set_translation

Sets the translation (position) of the Primitive Instance. 
set_translation(number: address, Vector3: value): void
​
address
number
required
The Primitive Instance address.
​
value
Vector3
required
The position vector to set for the primitive.

​
set_cframe

Sets the CFrame (coordinate frame) of the Primitive Instance. 
set_cframe(number: address, CFrame: value): void
​
address
number
required
The Primitive Instance address.
​
value
CFrame
required
The CFrame to set for the primitive’s position and orientation.

​
set_velocity

Sets the velocity of the Primitive Instance. 
set_velocity(number: address, Vector3: value): void
​
address
number
required
The Primitive Instance address.
​
value
Vector3
required
The velocity vector to set for the primitive.

​
set_size

Sets the size of the Primitive Instance. 
set_size(number: address, Vector3: value): void
​
address
number
required
The Primitive Instance address.
​
value
Vector3
required
The size vector to set for the part’s dimensions.

​
set_collision

Sets the collision bitmask value of the Primitive Instance. 
set_collision(number: address, number: value): void
​
address
number
required
The Primitive Instance address.
​
value
number
required
The collision bitmask value to set.

​
set_teleport

Teleports the Primitive Instance to the specified position. 
set_teleport(number: address, Vector3: value): void
​
address
number
required
The Primitive Instance address.
​
value
Vector3
required
The position vector to teleport the primitive to.

​
Bone

This section provides methods for inspecting and manipulating the spatial properties of a Bone instance. These functions are used to retrieve the bone’s rotation, translation, and CFrame, which are critical for warping and deforming associated meshes.

​
get_bone_rotation

Gets the rotation matrix of the Bone Instance. Returns a Matrix3 containing the bone’s rotation. 
get_bone_rotation(number: address): Matrix3
​
address
number
required
The Bone Instance address.

​
get_bone_translation

Gets the translation (position) of the Bone Instance. Returns a Vector3 containing the bone’s position. 
get_bone_translation(number: address): Vector3
​
address
number
required
The Bone Instance address.

​
get_bone_cframe

Gets the CFrame (coordinate frame) of the Bone Instance. Returns a CFrame containing the bone’s position and orientation. 
get_bone_cframe(number: address): CFrame
​
address
number
required
The Bone Instance address.

​
get_bone_primitive

Translates a Bone Instance address to its corresponding Primitive address, allowing primitive functions to work with bones. Returns the Primitive address as a number. 
get_bone_primitive(number: address): number
​
address
number
required
The Bone Instance address.

​
Humanoid

This section provides methods for inspecting and manipulating the core properties of a Humanoid instance. These functions control character health, speed, jump power, hip height, camera offset, and various behavioral states like sitting and auto-rotation.

​
get_camera_offset

Gets the camera offset of the Humanoid Instance. Returns a Vector3 containing the camera offset. 
get_camera_offset(number: address): Vector3
​
address
number
required
The Humanoid Instance address.

​
get_health

Gets the current health of the Humanoid Instance. Returns the health as a number. 
get_health(number: address): number
​
address
number
required
The Humanoid Instance address.

​
get_hip_height

Gets the hip height of the Humanoid Instance. Returns the hip height as a number. 
get_hip_height(number: address): number
​
address
number
required
The Humanoid Instance address.

​
get_jump_power

Gets the jump power of the Humanoid Instance. Returns the jump power as a number. 
get_jump_power(number: address): number
​
address
number
required
The Humanoid Instance address.

​
get_max_health

Gets the maximum health of the Humanoid Instance. Returns the max health as a number. 
get_max_health(number: address): number
​
address
number
required
The Humanoid Instance address.

​
get_walk_speed

Gets the walk speed of the Humanoid Instance. Returns the walk speed as a number. 
get_walk_speed(number: address): number
​
address
number
required
The Humanoid Instance address.

​
get_auto_rotate

Gets the auto-rotate state of the Humanoid Instance. Returns true if auto-rotate is enabled, false otherwise. 
get_auto_rotate(number: address): boolean
​
address
number
required
The Humanoid Instance address.

​
get_jump

Gets the jump state of the Humanoid Instance. Returns true if the humanoid is jumping, false otherwise. get_jump(number: address): boolean
​
address
number
required
The Humanoid Instance address.

​
get_sit

Gets the sit state of the Humanoid Instance. Returns true if the humanoid is sitting, false otherwise. 
get_sit(number: address): boolean
​
address
number
required
The Humanoid Instance address.

​
set_camera_offset

Sets the camera offset of the Humanoid Instance. 
set_camera_offset(number: address, Vector3: value): void
​
address
number
required
The Humanoid Instance address.
​
value
Vector3
required
The camera offset vector to set.

​
set_hip_height

Sets the hip height of the Humanoid Instance. 
set_hip_height(number: address, number: value)
​
address
number
required
The Humanoid Instance address.
​
value
number
required
The hip height to set.

​
set_jump_power

Sets the jump power of the Humanoid Instance. 
set_jump_power(number: address, number: value): void
​
address
number
required
The Humanoid Instance address.
​
value
number
required
The jump power to set.

​
set_walk_speed

Sets the walk speed of the Humanoid Instance. 
set_walk_speed(number: address, number: value): void
​
address
number
required
The Humanoid Instance address.
​
value
number
required
The walk speed to set.

​
set_auto_rotate

Sets the auto-rotate state of the Humanoid Instance. 
set_auto_rotate(number: address, boolean: value): void
​
address
number
required
The Humanoid Instance address.
​
value
boolean
required
Set to true to enable auto-rotate, false to disable it.

​
set_sit

Sets the sit state of the Humanoid Instance. 
set_sit(number: address, boolean: value): void
​
address
number
required
The Humanoid Instance address.
​
value
boolean
required
Set to true to make the humanoid sit, false to make it stand.

​
User Input

This section provides a method for inspecting the UserInputService instance to determine if an input element, such as a text box, currently has focus.

​
get_focused_box

Gets the current focused TextBox Instance that is being typed in from the UserInputService. Returns the TextBox Instance address as a number. 
get_focused_box(): number

​
Part Adornment

This section provides a method for inspecting instances of SurfaceGui or BillboardGui to retrieve the memory address of the Adornee part they are attached to and rendered upon.

​
get_adornee

Gets the Adornee property of an Instance such as SurfaceGui or BillboardGui. Returns the Adornee Instance address as a number. 
get_adornee(number: address): number
​
address
number
required
The Instance address (e.g., SurfaceGui, BillboardGui).

​
Gui Object

This section provides methods for inspecting properties shared across all GuiObject derivatives (e.g., Frame, TextButton, ImageLabel). These functions allow you to retrieve critical layout information, such as absolute position, absolute size, and the full absolute bounding rectangle on the screen.

​
get_absolute_position

Gets the absolute screen position of the GuiObject Instance. Returns a Vector2 containing the X and Y position. 
get_absolute_position(number: address): Vector2
​
address
number
required
The GuiObject Instance address.

​
get_absolute_size

Gets the absolute screen size of the GuiObject Instance. Returns a Vector2 containing the width and height. 
get_absolute_size(number: address): Vector2
​
address
number
required
The GuiObject Instance address.

​
get_absolute_rect

Gets the absolute screen rectangle of the GuiObject Instance. Returns a Rect where low is the position and high is the size. 
get_absolute_rect(number: address): Rect
​
address
number
required
The GuiObject Instance address.

​
Text Label

This section provides a method for inspecting the TextLabel instance to retrieve the string content currently being displayed.

​
get_label_text

Gets the text content of the TextLabel Instance. Returns the text as a string. 
get_label_text(number: address): string
​
address
number
required
The TextLabel Instance address.

​
Text Button

This section provides a method for inspecting the TextButton instance to retrieve the string content that is rendered on the button’s surface.

​
get_button_text

Gets the text content of the TextButton Instance. Returns the text as a string. 
get_button_text(number: address): string
​
address
number
required
The TextButton Instance address.

​
Text Box

This section provides a method for inspecting the TextBox instance to retrieve the string content currently entered or stored within the input field.

​
get_box_text

Gets the text content of the TextBox Instance. Returns the text as a string. 
get_box_text(number: address): string
​
address
number
required
The TextBox Instance address.

​
Tool

This section provides methods for inspecting and manipulating properties of a Tool instance, including retrieving its texture reference and accessing or setting the tool’s grip position and orientation.

​
get_tool_texture

Gets the texture ID of the Tool Instance. Returns the texture ID as a string. 
get_tool_texture(number: address): string
​
address
number
required
The Tool Instance address.

​
get_tool_grip

Gets the grip CFrame of the Tool Instance. Returns a CFrame containing the tool’s grip position and orientation. 
get_tool_grip(number: address): CFrame
​
address
number
required
The Tool Instance address.

​
set_tool_grip

Sets the grip CFrame of the Tool Instance. 
set_tool_grip(number: address, CFrame: value): void
​
address
number
required
The Tool Instance address.
​
value
CFrame
required
The CFrame to set for the tool’s grip position and orientation.

​
Value

This section provides methods for inspecting and manipulating the stored data within various Value-based instances (e.g., NumberValue, ObjectValue, StringValue). These functions allow you to read and write the core primitive or structure held by the respective value object.

​
get_int_value

Gets the stored integer value of the IntValue Instance. Returns the integer as a number. 
get_int_value(number: address): number
​
address
number
required
The IntValue Instance address.

​
get_bool_value

Gets the stored boolean value of the BoolValue Instance. Returns true or false. 
get_bool_value(number: address): boolean
​
address
number
required
The BoolValue Instance address.

​
get_cframe_value

Gets the stored CFrame value of the CFrameValue Instance. Returns a CFrame. 
get_cframe_value(number: address): CFrame
​
address
number
required
The CFrameValue Instance address.

​
get_number_value

Gets the stored number value of the NumberValue Instance. Returns the number as a double. 
get_number_value(number: address): number
​
address
number
required
The NumberValue Instance address.

​
get_object_value

Gets the stored object reference of the ObjectValue Instance. Returns the referenced Instance address as a number. 
get_object_value(number: address): number
​
address
number
required
The ObjectValue Instance address.

​
get_string_value

Gets the stored string value of the StringValue Instance. Returns the string. 
get_string_value(number: address): string
​
address
number
required
The StringValue Instance address.

​
get_vector3_value

Gets the stored Vector3 value of the Vector3Value Instance. Returns a Vector3. 
get_vector3_value(number: address): Vector3
​
address
number
required
The Vector3Value Instance address.

​
get_brick_color_value

Gets the stored BrickColor ID of the BrickColorValue Instance. Returns the BrickColor ID as a number. 
get_brick_color_value(number: address): number
​
address
number
required
The BrickColorValue Instance address.

​
set_int_value

Sets the stored integer value of the IntValue Instance. 
set_int_value(number: address, number: value): void
​
address
number
required
The IntValue Instance address.
​
value
number
required
The integer value to set.

​
set_bool_value

Sets the stored boolean value of the BoolValue Instance. 
set_bool_value(number: address, boolean: value): void
​
address
number
required
The BoolValue Instance address.
​
value
boolean
required
The boolean value to set.

​
set_cframe_value

Sets the stored CFrame value of the CFrameValue Instance. 
set_cframe_value(number: address, CFrame: value): void
​
address
number
required
The CFrameValue Instance address.
​
value
CFrame
required
The CFrame value to set.

​
set_number_value

Sets the stored number value of the NumberValue Instance. 
set_number_value(number: address, number: value): void
​
address
number
required
The NumberValue Instance address.
​
value
number
required
The number value to set.

​
set_object_value

Sets the stored object reference of the ObjectValue Instance. 
set_object_value(number: address, number: value): void
​
address
number
required
The ObjectValue Instance address.
​
value
number
required
The Instance address to set as the object reference.

​
set_vector3_value

Sets the stored Vector3 value of the Vector3Value Instance. 
set_vector3_value(number: address, Vector3: value): void
​
address
number
required
The Vector3Value Instance address.
​
value
Vector3
required
The Vector3 value to set.

​
set_brick_color_value

Sets the stored BrickColor ID of the BrickColorValue Instance. 
set_brick_color_value(number: address, number: value): void
​
address
number
required
The BrickColorValue Instance address.
​
value
number
required
The BrickColor ID to set.

​
Stats Item

This section provides methods for inspecting and manipulating the stored data within a StatsItem instance. These functions allow you to read and write both the numerical and string values contained within the item.

​
get_stats_value

Gets the numeric value of the StatsItem Instance. Returns the value as a number. 
get_stats_value(number: address): number
​
address
number
required
The StatsItem Instance address.

​
get_stats_svalue

Gets the string value of the StatsItem Instance. Returns the value as a string. 
get_stats_svalue(number: address): string
​
address
number
required
The StatsItem Instance address.

​
set_stats_value

Sets the numeric value of the StatsItem Instance. 
set_stats_value(number: address, number: value): void
​
address
number
required
The StatsItem Instance address.
​
value
number
required
The numeric value to set.

​
Mesh Part

This section provides methods for inspecting the MeshPart instance to retrieve the IDs referencing its mesh geometry and associated texture map.

​
get_mesh_part_mesh

Gets the mesh ID of the MeshPart Instance. Returns the mesh ID as a string. 
get_mesh_part_mesh(number: address): string
​
address
number
required
The MeshPart Instance address.

​
get_mesh_part_texture

Gets the texture ID of the MeshPart Instance. Returns the texture ID as a string. 
get_mesh_part_texture(number: address): string
​
address
number
required
The MeshPart Instance address.

​
Special Mesh

This section provides methods for inspecting the SpecialMesh instance to retrieve the IDs referencing its mesh geometry and associated texture map.

​
get_special_mesh_id

Gets the mesh ID of the SpecialMesh Instance. Returns the mesh ID as a string. 
get_special_mesh_id(number: address): string
​
address
number
required
The SpecialMesh Instance address.

​
get_special_texture_id

Gets the texture ID of the SpecialMesh Instance. Returns the texture ID as a string. 
get_special_texture_id(number: address): string
​
address
number
required
The SpecialMesh Instance address.

​
Texture

This section provides methods for inspecting the Texture instance to retrieve properties such as the ID referencing the image asset and its associated color value.

​
get_texture_texture

Gets the texture ID of the Texture Instance. Returns the texture ID as a string. 
get_texture_texture(number: address): string
​
address
number
required
The Texture Instance address.

​
get_texture_color

Gets the texture color of the Texture Instance. Returns the texture color as a Color3. 
get_texture_color(number: address): Color3
​
address
number
required
The Texture Instance address.

​
Decal

This section provides methods for inspecting the Decal instance to retrieve properties such as the ID referencing the image asset and its associated color value.

​
get_decal_texture

Gets the texture ID of the Decal Instance. Returns the texture ID as a string. 
get_decal_texture(number: address): string
​
address
number
required
The Decal Instance address.

​
get_decal_color

Gets the decal color of the Decal Instance. Returns the decal color as a Color3. 
get_decal_color(number: address): Color3
​
address
number
required
The Decal Instance address.

​
Sound

This section provides a method for inspecting the Sound instance to retrieve the ID referencing the audio asset it is configured to play.

​
get_sound_id

Gets the sound ID of the Sound Instance. Returns the sound ID as a string. 
get_sound_id(number: address): string
​
address
number
required
The Sound Instance address.
⌘I