Events
Control
if
control
Execute the nested code blocks only if the condition is true.
Library
if
Editor
if
condition
else if
control
Conditionally run code if the previous 'if' and 'else if' code blocks' conditions were false but this one's is true.
Library
else if
Editor
else if
condition
else
control
Run code if the previous 'if' and 'else if' code blocks' conditions were false.
Library
else
Editor
else
while
control
Run code repeatedly while the condition is true.
Library
while
Editor
while
condition
Events
when world is started
event
Execute the nested code blocks when the world instance starts.
Library
when world is started
Editor
when world is started
when event is received
event
Execute the nested code blocks when 'self' receives the given event.
Library
when event is received
Editor
when
on update
event
Run code blocks every frame, specifying to run them before or after the physics engine updates.
Library
on update
Editor
on update after
# deltaTime
secondsEvent Actions
send event to object
event
Send an event, possibly with parameters, to an object.
Library
send event to object
Editor
send
event
to object
with parameters
send event with delay
event
Send an event, possibly with parameters, to an object after a delay.
Library
send event with delay
Editor
send
event
to object
after seconds
seconds with parameters
cancel sending with delay
event
Cancels a scheduled event that was sent with a delay.
Library
cancel sending with delay
Editor
cancel sending event
event
to object
Collision Events
when trigger is entered by object
event
Executes when an object enters a trigger volume.
Library
when trigger is entered by object
Editor
when trigger is entered by
object
when trigger is exited by object
event
Executes when an object exits a trigger volume.
Library
when trigger is exited by object
Editor
when trigger is exited by
object
when colliding with object
event
Executes when this object starts colliding with another object.
Library
when colliding with object
Editor
when colliding with
object
when colliding with object with info
event
Executes on collision and provides detailed information like impact point and normal.
Library
when colliding with object with info
Editor
when colliding with
object
with info point
normal
relativeVelocity
when colliding with player
event
Executes when this object starts colliding with a player.
Library
when colliding with player
Editor
when colliding with
player
when colliding with player with info
event
Executes on collision with a player and provides detailed information.
Library
when colliding with player with info
Editor
when colliding with
player
with info point
normal
relativeVelocity
Player Events
when trigger is entered by player
event
Executes when a player enters a trigger volume.
Library
when trigger is entered by player
Editor
when trigger is entered by
player
when trigger is exited by player
event
Executes when a player exits a trigger volume.
Library
when trigger is exited by player
Editor
when trigger is exited by
player
when player enters the world
event
Execute the nested code blocks when a player first enters this instance.
Library
when player enters the world
Editor
when world is entered by
player
when player exits the world
event
Execute the nested code blocks when a player exits this instance.
Library
when player exits the world
Editor
when world is exited by
player
when player becomes AFK
event
Execute the nested code blocks when a player becomes AFK.
Library
when player becomes AFK
Editor
when
player
becomes AFKwhen player returns from AFK
event
Execute the nested code blocks when a player returns from being AFK.
Library
when player returns from AFK
Editor
when
player
returns from being AFKProjectile Events
when projectile hits player
event
Executes when a projectile launched by this object hits a player.
Library
when projectile hits player
Editor
when projectile hits player
player
pos
normal
head
when projectile hits interactive object
event
Executes when a projectile hits an interactive object.
Library
when projectile hits interactive object
Editor
when projectile hits interactive object
object
pos
normal
when projectile hits static object
event
Executes when a projectile hits a static (non-interactive) object.
Library
when projectile hits static object
Editor
when projectile hits static object
pos
normal
Spawning
when an asset spawns
event
Called any time an asset is spawned successfully. Can be placed in any script.
Library
when an asset spawns
Editor
when an asset spawns
obj
asset
when an asset despawns
event
Called any time an asset is despawned. Will be called after the objects have already been destroyed. Can be placed in any script.
Library
when an asset despawns
Editor
when an asset despawns
obj
asset
when an asset spawn fails
event
Called any time an asset fails to spawn. This is likely due to exceeding capacity in the world. Can be placed in any script.
Library
when an asset spawn fails
Editor
when an asset spawn fails
asset
when an asset spawns from player inventory
event
Called any time an asset is spawned from a player's inventory.
Library
when an asset spawns from player inventory
Editor
when asset spawns
obj
asset
from player
inventoryIn-World Item Events
when player purchase succeeds on item
event
Called when a player successfully purchases an item.
Library
when player purchase succeeds on item
Editor
when
player
purchase succeeds on itemwhen player purchase fails on item
event
Called when a player fails to purchase an item.
Library
when player purchase fails on item
Editor
when
player
purchase fails on itemwhen player starts purchase item (broadcast)
event
Called when a player starts a purchase.
Library
when player starts purchase item (broadcast)
Editor
when
player
starts purchase itemId
when player completes purchase item (broadcast)
event
Called when a player completes a purchase.
Library
when player completes purchase item (broadcast)
Editor
when
player
completes purchase itemId
success success
when player consume succeeds on item
event
Called when a player successfully consumes an item.
Library
when player consume succeeds on item
Editor
when
player
consume succeeds on itemwhen player consume fails on item
event
Called when a player fails to consume an item.
Library
when player consume fails on item
Editor
when
player
consume fails on itemwhen player try to consume item
event
Called when a player tries to consume an item from their inventory.
Library
when player try to consume item
Editor
when
player
try to consume item from inventorywhen player starts consume item (broadcast)
event
Called when a player starts a consume.
Library
when player starts consume item (broadcast)
Editor
when
player
starts consume itemId
when player completes consume item (broadcast)
event
Called when a player completes a consume.
Library
when player completes consume item (broadcast)
Editor
when
player
completes consume itemId
success success
Grab Events
when object is grabbed by player
event
Executes when an object is grabbed by a player.
Library
when object is grabbed by player
Editor
when object is grabbed by
player
when object is grabbed by player with hand
event
Executes when an object is grabbed by a specific hand of a player.
Library
when object is grabbed by player with hand
Editor
when object is grabbed by the
isRight
hand of player
when object is released by player
event
Executes when an object is released by a player.
Library
when object is released by player
Editor
when object is released by
player
when object is grabbed by two hands
event
Executes when an object is grabbed by both hands of a player.
Library
when object is grabbed by two hands
Editor
when object is grabbed with two hands of
player
when object is no longer grabbed by two hands
event
Executes when an object is no longer grabbed by both hands.
Library
when object is no longer grabbed by two hands
Editor
when object is no longer grabbed with two hands of
player
Attachable Events
when object is attached to player
event
Executes when an object is attached to a player.
Library
when object is attached to player
Editor
when object is attached to
player
when object is unattached from player
event
Executes when an object is unattached from a player.
Library
when object is unattached from player
Editor
when object is unattached from
player
Controller Events
when index trigger is pressed while grabbed by player
event
Executes when the index trigger is pressed while a player is grabbing the object.
Library
when index trigger is pressed while grabbed by player
Editor
when index trigger is pressed while grabbed by
player
when index trigger is released while grabbed by player
event
Executes when the index trigger is released while a player is grabbing the object.
Library
when index trigger is released while grabbed by player
Editor
when index trigger is released while grabbed by
player
when button 1 is pressed while grabbed by player
event
Executes when button 1 is pressed while a player is grabbing the object.
Library
when button 1 is pressed while grabbed by player
Editor
when button 1 is pressed while grabbed by
player
when button 1 is released while grabbed by player
event
Executes when button 1 is released while a player is grabbing the object.
Library
when button 1 is released while grabbed by player
Editor
when button 1 is released while grabbed by
player
when button 2 is pressed while grabbed by player
event
Executes when button 2 is pressed while a player is grabbing the object.
Library
when button 2 is pressed while grabbed by player
Editor
when button 2 is pressed while grabbed by
player
when button 2 is released while grabbed by player
event
Executes when button 2 is released while a player is grabbing the object.
Library
when button 2 is released while grabbed by player
Editor
when button 2 is released while grabbed by
player
when button is pressed while grabbed by player
event
Called when a button is pressed while the object is grabbed.
Library
when button is pressed while grabbed by player
Editor
when button
button
is pressed while grabbed by player
when button is released while grabbed by player
event
Called when a button is released while the object is grabbed.
Library
when button is released while grabbed by player
Editor
when button
button
is released while grabbed by player
Connections
connect to event
action
Register for an event to be forwarded from an object/player to this object.
Library
connect to event
Editor
connect
object
to local eventevent
listen to event
action
Register for all events to be forwarded from an object/player to this object.
Library
listen to event
Editor
Listen to events from
object
stop listening to events
action
Stop listening to events from an object/player.
Library
stop listening to events
Editor
N/A
Achievements
when an achievement is completed
event
Executes when a player completes a specific achievement.
Library
when an achievement is completed
Editor
when achievement completes for player
player
, achievementId
Motion
Instant Motion
move to
action
Instantly moves an object to a new position.
Library
move to
Editor
move to
position
move by
action
Instantly moves an object by a certain offset.
Library
move by
Editor
move by
position
rotate to
action
Instantly rotates an object to a new orientation.
Library
rotate to
Editor
rotate to
rotation
rotate by
action
Instantly rotates an object by a certain amount.
Library
rotate by
Editor
rotate by
rotation
scale to
action
Instantly scales an object to a specific size.
Library
scale to
Editor
scale to
scale
multiply scale by
action
Instantly multiplies an object's scale by a factor.
Library
multiply scale by
Editor
multiply scale by
scale
Motion Over Time
move to over time
action
Moves an object to a new position over a specified duration.
Library
move to over time
Editor
move to
position
over time
smove by over time
action
Moves an object by an offset over a specified duration.
Library
move by over time
Editor
move by
position
over time
srotate to over time
action
Rotates an object to a new orientation over a specified duration.
Library
rotate to over time
Editor
rotate to
rotation
over time
srotate by over time
action
Rotates an object by a certain amount over a specified duration.
Library
rotate by over time
Editor
rotate by
rotation
over time
sscale to over time
action
Scales an object to a specific size over a specified duration.
Library
scale to over time
Editor
scale to
scale
over time
sscale by over time
action
Multiplies an object's scale by a factor over a specified duration.
Library
scale by over time
Editor
scale by
scale
over time
sPlayer Motion
respawn player
action
Respawns a player to a specific spawn point.
Library
respawn player
Editor
respawn
player
to spawn point
set player speed
action
Sets the movement speed of a player.
Library
set player speed
Editor
N/A
set player gravity
action
Sets the gravity for a player.
Library
set player gravity
Editor
N/A
add player physical velocity
action
Adds to the physical velocity of a player.
Library
add player physical velocity
Editor
N/A
set player physical velocity
action
Sets the physical velocity of a player.
Library
set player physical velocity
Editor
N/A
move player by offset
action
Instantly moves a player by a certain offset.
Library
move player by offset
Editor
N/A
move player to position
action
Instantly moves a player to a new position.
Library
move player to position
Editor
N/A
Physical Motion
set object physical motion
action
Sets whether an object is affected by physics.
Library
set object physical motion
Editor
set
object
simulation to boolean
push
action
Applies a force to an object.
Library
push
Editor
N/A
push with mass
action
Applies a force to an object, taking its mass into account.
Library
push with mass
Editor
N/A
push at position with mass
action
Applies a force to an object at a specific position.
Library
push at position with mass
Editor
N/A
push in local space
action
Applies a force to an object in its local space.
Library
push in local space
Editor
N/A
push in local space with mass
action
Applies a force to an object in its local space, taking mass into account.
Library
push in local space with mass
Editor
N/A
spin
action
Applies a torque to an object.
Library
spin
Editor
N/A
spin in local space
action
Applies a torque to an object in its local space.
Library
spin in local space
Editor
N/A
stop physical motion
action
Stops all physical motion of an object.
Library
stop physical motion
Editor
N/A
launch from object
action
Launches an object from another object with a given speed.
Library
launch from object
Editor
N/A
spring push object toward position
action
Applies a spring force to push an object towards a target position.
Library
spring push object toward position
Editor
spring push
object
toward position
with stiffness k
and critical damping ratio ratio
per axis axis independent
spring spin object toward rotation
action
Applies a spring torque to spin an object towards a target rotation.
Library
spring spin object toward rotation
Editor
spring spin
object
toward rotation
with stiffness k
and critical damping ratio ratio
per axis axis independent
Actions
Object
set object visibility
action
Sets whether an object is visible or not.
Library
set object visibility
Editor
set
object
visibility to boolean
set object collidability
action
Sets whether an object can be collided with.
Library
set object collidability
Editor
set
object
collidability to boolean
set object color
action
Sets the color of an object.
Library
set object color
Editor
set
object
color to color
set object detection
action
Enables or disables an object's detection capabilities.
Library
set object detection
Editor
set
object
detection to boolean
set object simulation
action
Sets whether an object is simulated by the physics engine.
Library
set object simulation
Editor
set
object
simulation to boolean
set object gravity
action
Enables or disables gravity for an object.
Library
set object gravity
Editor
set
object
gravity to boolean
set object interaction
action
Sets how a player can interact with an object.
Library
set object interaction
Editor
set
object
interaction to force hold object
action
Forces a player to hold an object.
Library
force hold object
Editor
force hold
object
on the hand of player
allowing manual release boolean
force release on object
action
Forces a player to release a held object.
Library
force release on object
Editor
force release on
object
set who can grab
action
Defines which players are allowed to grab an object.
Library
set who can grab
Editor
set who can grab
object
to assignee(s)
attach object to player
action
Attaches an object to a specific point on a player's body.
Library
attach object to player
Editor
attach
object
to player player
detach object
action
Detaches an object from whatever it is attached to.
Library
detach object
Editor
detach
object
launch projectile from object
action
Launches a projectile from an object.
Library
launch projectile from object
Editor
launch projectile from
object
launch projectile from object at speed
action
Launches a projectile with a specific speed.
Library
launch projectile from object at speed
Editor
launch projectile from
object
at speed speed
set projectile gravity
action
Sets the gravity for a launched projectile.
Library
set projectile gravity
Editor
set gravity of projectiles from
object
to speed
Set who is allowed to view object
action
Restricts which players can see an object.
Library
Set who is allowed to view object
Editor
Set who is allowed to view
object
to list
Reset who is allowed to view object
action
Resets visibility, allowing all players to see an object.
Library
Reset who is allowed to view object
Editor
Reset who is allowed to view
object
Text
display text
action
Displays text in the world.
Library
display text
Editor
display text
text
Animation
play animation
action
Plays an animation on an object.
Library
play animation
Editor
play animation on
object
pause animation
action
Pauses a currently playing animation.
Library
pause animation
Editor
pause animation on
object
stop animation
action
Stops a currently playing animation.
Library
stop animation
Editor
stop animation on
object
Sound
play sound
action
Plays a sound effect.
Library
play sound
Editor
play sound on
object
pause sound
action
Pauses a playing sound.
Library
pause sound
Editor
pause sound on
object
stop sound
action
Stops a playing sound.
Library
stop sound
Editor
stop sound on
object
set sound volume
action
Sets the volume of a sound.
Library
set sound volume
Editor
set volume of
object
to volume
set sound volume with fade
action
Fades the volume of a sound over time.
Library
set sound volume with fade
Editor
set volume of
object
to volume
over duration
secondsset sound pitch
action
Sets the pitch of a sound.
Library
set sound pitch
Editor
set pitch of
object
to pitch
set sound pitch with fade
action
Changes the pitch of a sound over time.
Library
set sound pitch with fade
Editor
set pitch of
object
to pitch
over duration
secondsVFX
play visual fx
action
Plays a visual effect.
Library
play visual fx
Editor
play visual fx
object
stop visual fx
action
Stops a visual effect.
Library
stop visual fx
Editor
stop visual fx on
object
World
reset world state
action
Resets the world to its initial state.
Library
reset world state
Editor
reset world state
Player
transfer ownership of object to player
action
Changes the owner of an object.
Library
transfer ownership of object to player
Editor
transfer ownership of
object
to player
owner of object
value
Gets the player who owns an object.
Library
owner of object
Editor
transfer ownership of
object
to owner of object
play haptics on player controller
action
Triggers haptic feedback on a player's controller.
Library
play haptics on player controller
Editor
play haptics on hand of
player
for durationMs
ms with set player voice setting to
action
Changes the voice settings for a player.
Library
set player voice setting to
Editor
set voice setting to for
player
Player Entitlements
consume item for player
action
Consumes an item from a player's inventory.
Library
consume item for player
Editor
consume
itemid
for player
Hand
set physical hand collision
action
Sets whether a player's hands have physical collision.
Library
set physical hand collision
Editor
set player physical hands collision with dynamic objects
boolean
static objects boolean
Light
set property on light
action
Changes a property of a light source.
Library
set property on light
Editor
set intensity on
light
to value
set light enabled
action
Enables or disables a light source.
Library
set light enabled
Editor
set light
light
enabled to enabled
Achievements
set achievements displayed on gizmo
action
Sets which achievements are displayed on a gizmo.
Library
set achievements displayed on gizmo
Editor
set achievements gizmo
object
to show list
set achievement complete for player
action
Marks an achievement as complete for a player.
Library
set achievement complete for player
Editor
Set Achievement
changeMe
complete for player
to boolean
Spawning
spawn asset
action
Spawns an asset in the world.
Library
spawn asset
Editor
spawn asset
asset
spawn asset with callback
action
Spawns an asset and triggers a callback upon completion.
Library
spawn asset with callback
Editor
Spawn asset
asset
at position
rotated by rotation
scaled by scale
with event event
sent to object
with parameters
delete spawned asset
action
Deletes a previously spawned asset.
Library
delete spawned asset
Editor
delete spawned asset
asset
delete single spawned object
action
Deletes a single object that was spawned from an asset.
Library
delete single spawned object
Editor
Delete single spawned object
object
HWXS
Trigger grip animation for player
action
Triggers a grip animation for a player.
Library
Trigger grip animation for player
Editor
On player
player
trigger grip animation string
Raycast
raycast
action
Performs a raycast to detect objects in a line.
Library
raycast
Editor
raycast with
raycast gizmo
raycast with overrides
action
Performs a raycast with additional options.
Library
raycast with overrides
Editor
raycast with
raycast gizmo
from origin
direction direction
Popup
show simple popup for player
action
Shows a simple popup message to a player.
Library
show simple popup for player
Editor
Show pop-up for
player
with text
for time
secondsshow popup for player
action
Shows a more complex popup to a player.
Library
show popup for player
Editor
Show pop-up for
player
with text
for time
seconds with position position
font size fontsize
color textColor
with bg bgColor
play sound sfx
show timer showTimer
show popup for all players
action
Shows a popup message to all players.
Library
show popup for all players
Editor
Show everyone a pop-up with
text
for time
seconds with position position
font size fontsize
color textColor
with bg bgColor
play sound sfx
show timer showTimer
Values
Values
set to
action
Sets the value of a variable.
Library
set to
Editor
set
variable
to value
set player persistent var
action
Sets a persistent variable for a player.
Library
set player persistent var
Editor
set
name
to value
for player
get user persistent var
value
Gets the value of a player's persistent variable.
Library
get user persistent var
Editor
get user persistent variable
name
value for player
set world leaderboard score
action
Sets the score for a player on a world leaderboard.
Library
set world leaderboard score
Editor
set world leaderboard
id
for player
to score
force: boolean
Debugging
debug print
action
Prints a message to the debug console.
Library
debug print
Editor
N/A
comment
comment
Adds a comment to the script, which is ignored during execution.
Library
comment
Editor
comment
Type Casting
variable as string
value
Converts a variable to a string.
Library
variable as string
Editor
variable as string
variable
variable as color
value
Converts a variable to a color.
Library
variable as color
Editor
variable as color
Appearance is the same in the editor.
variable as vector
value
Converts a variable to a vector.
Library
variable as vector
Editor
variable as vector
Appearance is the same in the editor.
variable as number
value
Converts a variable to a number.
Library
variable as number
Editor
variable as number
Appearance is the same in the editor.
Value Input
self
object
A reference to the object the script is attached to.
Library
self
Editor
self
Appearance is the same in the editor.
server player
playerid
The ID of the server player.
Library
server player
Editor
server player
Appearance is the same in the editor.
number input
scalar
A constant number value.
Library
number input
Editor
number input
Appearance is the same in the editor.
boolean input
boolean
A constant boolean value (true or false).
Library
boolean input
Editor
boolean input
Appearance is the same in the editor.
vector input
vector
A constant vector value.
Library
vector input
Editor
vector input
Appearance is the same in the editor.
rotation input
rotation
A constant rotation value.
Library
rotation input
Editor
rotation input
Appearance is the same in the editor.
color input
color
A constant color value.
Library
color input
Editor
color input
Appearance is the same in the editor.
string input
string
A constant string value.
Library
string input
Editor
string input
Appearance is the same in the editor.
in-world items
list
A list of all items currently in the world.
Library
[]in-world items
items:
Editor
[]in-world items
items:
Appearance is the same in the editor.
Constants
pi
scalar
The mathematical constant Pi (≈3.14159).
Library
pi
Editor
pi
Appearance is the same in the editor.
Operators
Logic
==
value
Library
==
Editor
value
==value
!=
value
Library
!=
Editor
value
!=value
<
value
Library
<
Editor
value
<value
>
value
Library
>
Editor
value
>value
<=
value
Library
<=
Editor
value
<=value
>=
value
Library
>=
Editor
value
>=value
and
value
Library
and
Editor
value
andvalue
or
value
Library
or
Editor
value
orvalue
not
value
Library
not
Editor
value
notvalue
Basic Operations
+
value
Library
+
Editor
value
+value
-
value
Library
-
Editor
value
-value
*
value
Library
*
Editor
value
*value
/
value
Library
/
Editor
value
/value
%
value
Library
%
Editor
value
%value
Basic Math
abs
value
Library
abs
Editor
abs
value
ceil
value
Library
ceil
Editor
ceil
value
clamp
value
Library
clamp
Editor
clamp
value
min
max
floor
value
Library
floor
Editor
floor
number
frac
value
Library
frac
Editor
frac
number
lerp
value
Library
lerp
Editor
lerp from
from
to to
alpha alpha
max
value
Library
max
Editor
max
a
b
min
value
Library
min
Editor
min
a
b
sqrt
value
Library
sqrt
Editor
sqrt
number
smooth damp
value
Library
smooth damp
Editor
smooth damp from
from
to to
velocity var velocity var
speed speed
max speed max speed
Advanced Math
pow
value
Library
pow
Editor
pow
base
exponent
cos
value
Library
cos
Editor
cos
number
sin
value
Library
sin
Editor
sin
number
tan
value
Library
tan
Editor
tan
number
acos
value
Library
acos
Editor
acos
number
asin
value
Library
asin
Editor
asin
number
atan2
value
Library
atan2
Editor
atan2
y
x
exp
value
Library
exp
Editor
exp
number
log10
value
Library
log10
Editor
log10
number
radians to degrees
value
Library
radians to degrees
Editor
radians to degrees
number
degrees to radians
value
Library
degrees to radians
Editor
degrees to radians
number
Random Numbers
random number with decimals
value
Generates a random floating-point number between 0.0 and 1.0.
Library
random number with decimals
Editor
random number with decimals
random number
value
Generates a random integer.
Library
random number
Editor
random number
random between
value
Generates a random floating-point number in a range.
Library
random between
Editor
random between
min
and max
random integer between
value
Generates a random integer in a range.
Library
random integer between
Editor
random integer between
min
and max
2d perlin noise
value
Generates a 2D Perlin noise value.
Library
2d perlin noise
Editor
2d perlin noise
x
y
Object Transform
position of
value
Gets the position of an object.
Library
position of
Editor
position of
object
rotation of
value
Gets the rotation of an object.
Library
rotation of
Editor
rotation of
object
scale of
value
Gets the scale of an object.
Library
scale of
Editor
scale of
object
angular velocity of
value
Gets the angular velocity of an object.
Library
angular velocity of
Editor
angular velocity of
object
velocity of
value
Gets the velocity of an object.
Library
velocity of
Editor
velocity of
object
forward direction of
value
Gets the forward direction vector of an object.
Library
forward direction of
Editor
forward direction of
object
upward direction of
value
Gets the upward direction vector of an object.
Library
upward direction of
Editor
upward direction of
object
is allowed to view
value
Checks if a player is allowed to view an object.
Library
is allowed to view
Editor
player
is allowed to view object
get who is allowed to view object
action
Gets the list of players allowed to view an object.
Library
get who is allowed to view object
Editor
N/A
Vector Math
new vector from xyz
value
Creates a new vector from X, Y, and Z components.
Library
new vector from xyz
Editor
new vector
x
y
z
x of vector
value
Gets the X component of a vector.
Library
x of vector
Editor
x of
vector
y of vector
value
Gets the Y component of a vector.
Library
y of vector
Editor
y of
vector
z of vector
value
Gets the Z component of a vector.
Library
z of vector
Editor
z of
vector
normalize
value
Normalizes a vector to have a magnitude of 1.
Library
normalize
Editor
normalize
vector
dot
value
Calculates the dot product of two vectors.
Library
dot
Editor
dot
vector
vector
cross
value
Calculates the cross product of two vectors.
Library
cross
Editor
cross
vector
vector
distance from
value
Calculates the distance between two vectors.
Library
distance from
Editor
distance from
vector
vector
magnitude of
value
Calculates the magnitude (length) of a vector.
Library
magnitude of
Editor
magnitude of
vector
reflect
value
Reflects a vector off a surface with a given normal.
Library
reflect
Editor
reflect
vector
normal
new rotation
value
Creates a new rotation from Euler angles.
Library
new rotation
Editor
new rotation
x
y
z
look towards
value
Creates a rotation that looks from one point to another.
Library
look towards
Editor
look towards
forward
with up up
inverse of
value
Calculates the inverse of a rotation.
Library
inverse of
Editor
inverse of
rotation
rotation of
value
Creates a rotation of an angle around an axis.
Library
rotation of
Editor
rotation of
angle
around axis
angle of
value
Gets the angle of a rotation.
Library
angle of
Editor
angle of
rot
axis of
value
Gets the axis of a rotation.
Library
axis of
Editor
axis of
rot
Color
new color
value
Creates a new color from RGB values.
Library
new color
Editor
new color
r
g
b
convert rgb to hsv
value
Converts a color from RGB to HSV color space.
Library
convert rgb to hsv
Editor
convert rgb to hsv
color
hsv to rgb
value
Converts a color from HSV to RGB color space.
Library
hsv to rgb
Editor
hsv to rgb
color
color of object
value
Gets the color of an object.
Library
color of object
Editor
color of
object
get component of color
value
Gets a specific component (R, G, B, or A) of a color.
Library
get component of color
Editor
get component of
color
Player
is player in build mode
value
Checks if a player is in build mode.
Library
is player in build mode
Editor
is
player
in build modeposition of player
value
Gets the position of a player.
Library
position of player
Editor
position of
player
physical velocity of player
value
Gets the physical velocity of a player.
Library
physical velocity of player
Editor
physical velocity of
player
forward of player
value
Gets the forward direction vector of a player.
Library
forward of player
Editor
forward of
player
upward of player
value
Gets the upward direction vector of a player.
Library
upward of player
Editor
upward of
player
name of player
value
Gets the name of a player.
Library
name of player
Editor
name of
player
get index of player
value
Gets the index of a player.
Library
get index of player
Editor
get index of
player
get player from index
value
Gets a player from their index.
Library
get player from index
Editor
get player from index
index
Text
length of string
value
Gets the length of a string.
Library
length of string
Editor
length of
string
substring of string
value
Gets a substring of a string.
Library
substring of string
Editor
substring of
string
from index start index
with length length
insert substring at index
action
Inserts a substring into a string at a specific index.
Library
insert substring at index
Editor
N/A
index of substring in string
action
Finds the index of a substring within a string.
Library
index of substring in string
Editor
N/A
remove from string
action
Removes a portion of a string.
Library
remove from string
Editor
N/A
List
length of list
value
Gets the number of items in a list.
Library
length of list
Editor
length of
list
add to list
action
Adds an item to the end of a list.
Library
add to list
Editor
add
item
to list
add value at index to list
action
Inserts an item into a list at a specific index.
Library
add value at index to list
Editor
in
list
insert item
at index index
set item at index in list
action
Replaces an item at a specific index in a list.
Library
set item at index in list
Editor
in
list
set index index
to item
remove item at index from list
action
Removes an item from a list at a specific index.
Library
remove item at index from list
Editor
remove from
list
at index index
remove item from list
action
Removes the first occurrence of a specific item from a list.
Library
remove item from list
Editor
remove
item
from list
clear list
action
Removes all items from a list.
Library
clear list
Editor
clear
list
get item from list
value
Retrieves an item from a list at a specific index.
Library
get item from list
Editor
get from
list
at index index
index of item in list
value
Finds the index of the first occurrence of an item in a list.
Library
index of item in list
Editor
index of
item
in list
list contains item
value
Checks if a list contains a specific item.
Library
list contains item
Editor
list
contains item
Raycast
get raycast data
value
Gets data from a raycast gizmo.
Library
get raycast data
Editor
get raycast data
Appearance is the same in the editor.
Spawning
get spawned objects
action
Gets a list of all objects spawned by an asset.
Library
get spawned objects
Editor
N/A
Time
current date and time
value
Gets the current date and time.
Library
current date and time
Editor
current date and time
Appearance is the same in the editor.
current timestamp
value
Gets the current timestamp.
Library
current timestamp
Editor
current timestamp
Appearance is the same in the editor.
HWXS
is player device vr
value
Checks if the player is using a VR device.
Library
is player device vr
Editor
is player device vr
Appearance is the same in the editor.
is player device mobile
value
Checks if the player is on a mobile device.
Library
is player device mobile
Editor
is player device mobile
Appearance is the same in the editor.
is player device desktop
value
Checks if the player is on a desktop computer.
Library
is player device desktop
Editor
is player device desktop
Appearance is the same in the editor.
Player Entitlements
player owns item
value
Checks if a player owns a specific item.
Library
player owns item
Editor
player owns item
Appearance is the same in the editor.
player owns item quantity
value
Gets the quantity of an item a player owns.
Library
player owns item quantity
Editor
player owns item quantity
Appearance is the same in the editor.
time since player consumed item
value
Gets the time since a player last consumed an item.
Library
time since player consumed item
Editor
time since player consumed item
Appearance is the same in the editor.
player has consumed item
value
Checks if a player has consumed an item.
Library
player has consumed item
Editor
player has consumed item
Appearance is the same in the editor.
Achievements
has player completed achievement
value
Checks if a player has completed a specific achievement.
Library
has player completed achievement
Editor
has player completed achievement
Appearance is the same in the editor.