Find nodes in the scene by name.

-- Find all Box objects in scene
BoxsArray = SimLabUtils:FindNodesByName("Box")

Find nodes in the scene by attribute name.

-- Find all airplane objects in scene
AirPlanesArray = SimLabUtils:FindNodesByAttribute("AirPlane")

Find animation sequences in the scene by name.

-- Assuming that Sequence_1 exists.
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:SetPlayRange(0, 100)

Find scene states in the scene by name.

local SceneStates = SimLabUtils:FindSceneStatesByName("Mid") -- Replace "Mid" with the name of your scene state.
local SceneState = SceneStates[1]

print(SceneState:GetSceneStateName())

SceneState:Apply()

Opens a VR package from a specified path and closes current scene.

-- Change from first level to second level in game
SimLabUtils:OpenVRPackage("C:/SecondLevel.vrpackage")

Import a VR package from a path or URL with a specified transform into the current scene.

local nodes = SimLabUtils:FindNodesByName("3DBox")
if nodes and nodes[1] then 
   -- Get the target transform
   local targetTransform = nodes[1]:GetNodeGlobalTransform()
   print(targetTransform)
   -- Import the VR package with the correct file path
   SimLabUtils:ImportVRPackage("C:/Users/YOUR_USERNAME/Desktop/Box.vrpackage", targetTransform)
   -- Note: Replace "C:/Users/YOUR_USERNAME/Desktop/Box.vrpackage" with the actual path to your .vrpackage file.
else
   print("Error: Node '3DBox' not found.")
end

Get a variable by name.

local NumVariable = SimLabUtils:GetVariableByName("num") -- Replace "num" with the name of your variable.
NumVariable:SetNumberValue(num + 2)

Get the first player controller.

-- Retrieve the first player controller.
local Player = SimLabUtils:GetFirstPlayerController()
local CameraLocation = Player:GetUserLocation()
print(CameraLocation.x)

Get the Device Category.

local DeviceCategory = SimLabUtils:GetDeviceCategory()
print(DeviceCategory)

Check whether the collaboration session is active.

-- Check if the user is in a collaboration session.
if SimLabUtils:InCollaboration() then 
 print("yes") 
else 
 print("no")  
end

Get language tag.

-- Get the current language of the system.
local Language = SimLabUtils:GetLanguage()
print(Language)

Get the active mode.

local Mode = SimLabUtils:GetActiveMode()
print(Mode)

Create a new HTTP request.

-- New Rest API request object
HttpRequest = SimLabUtils:NewHttpRequest()

Create a new JSON object.

-- Create a new JSON object
JSON_Object = SimLabUtils:NewJsonObject()

Create a new JSON value.

-- Create a new JSON value
local OutJSONArray1 = SimLabUtils:NewJsonValue()

Print a log message to the screen.

print("This is a log message.")

Get the material associated with this 3DObject SceneNode.

local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the SceneNode name that contains a material.
local Node = Nodes[1] -- Get first SceneNode
local NodeMaterial = Node:GetMaterial()
print(NodeMaterial:GetMaterialName())

Set the material for an 3DObject SceneNode.

-- Swap materials between two 3DObjects
local Nodes = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the SceneNode name that contains a material.
local Box = Nodes[1]

local Nodes2 = SimLabUtils:FindNodesByName("3DSphere") -- Replace "3DSphere" with the SceneNode name that contains a second material.
local Sphere = Nodes2[1]

local BoxMaterial = Box:GetMaterial()
local SphereMaterial = Sphere:GetMaterial()

print(BoxMaterial:GetMaterialName())
print(SphereMaterial:GetMaterialName())

Box:SetMaterial(SphereMaterial)
Sphere:SetMaterial(BoxMaterial)

Toggle the playback state of the sound.

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode") -- Replace "SoundNode" with the Attribute of your sound node.
local SoundNode = SoundNodes[1]
if SoundNode then
   SoundNode:ToggleState()
else
  print("No Sound node found")
end

Play the sound, restarting if already playing, or resuming if previously stopped.

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode") -- Replace "SoundNode" with the Attribute of your sound node. 
local SoundNode = SoundNodes[1]
if SoundNode then
   SoundNode:Play()
else
   print("No Sound node found")
end

Stop the sound playback.

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode") -- Replace "SoundNode" with the Attribute of your sound node. 
local SoundNode = SoundNodes[1]

if SoundNode then
   SoundNode:Stop()
else
   print("No Sound node found")
end

Seek to a specific time in the sound playback.

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode") -- Replace "SoundNode" with the Attribute of your sound node.
local SoundNode = SoundNodes[1]

if SoundNode then
   SoundNode:Seek(3) -- Seek to 3 seconds
else
   print("No Sound node found")
end

Play the sound for the specified duration or until it ends.

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode") -- Replace "SoundNode" with the Attribute of your sound node.
local SoundNode = SoundNodes[1]

if SoundNode then
   SoundNode:PlayDuration(2) -- Play for 2 seconds
else
   print("No Sound node found")
end

Get the camera's transform.

local Player = SimLabUtils:GetFirstPlayerController()
local CameraTransform = Player:GetCameraTransform()
print(tostring(CameraTransform))

local CameraRotation = CameraTransform.Rotation
print(tostring(CameraRotation))

local CameraLocation = CameraTransform.Translation
print(tostring(CameraLocation))

local ForwardVector = CameraRotation:GetForwardVector()
local NewLocation = CameraLocation + ForwardVector * -3

Get the user Name.

local Controller = SimLabUtils:GetFirstPlayerController()
local UserName = Controller:GetUserName() 
print(UserName)

Point the controller to a specified SceneNode.

local Controller = SimLabUtils:GetFirstPlayerController()
local Nodes = SimLabUtils:FindNodesByAttribute("Target") -- Replace "Target" with the name of your attribute. 
Controller:PointToNode(Nodes[1])

Remove the pointed object association from the controller.

local Controller = SimLabUtils:GetFirstPlayerController()
Controller:RemovePointToNode()

Teleport the controller to a specified location and orientation.

local Controller = SimLabUtils:GetFirstPlayerController()
Controller:TeleportToView(UE.FVector(0, 0, 200), UE.FRotator(0, 180, 0))

Teleport the controller to a specified location.

local Controller = SimLabUtils:GetFirstPlayerController()
Controller:TeleportToLocation(UE.FVector(0, 0, 200))

Set the request body with a JSON object. In the example we create a new JSON object and set the username and password of the user, then we assign it to the new HTTP request using

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetStringField("username", "SimLab123")
JSON_Object:SetStringField("password", "Pass123")

HttpRequest = SimLabUtils:NewHttpRequest()
HttpRequest:SetRequestBody(JSON_Object)

Process the HTTP request. Parameters allowed:

• GET
• POST
• DELETE
• PUT
• REQUEST
• PATCH

HttpRequest = SimLabUtils:NewHttpRequest()
HttpRequest:SetVerb("GET")
HttpRequest:SetEndpoint("http://api.apilayer.com/exchangerates_data/timeser
ies?start_date=2020-08-01")
HttpRequest:ProcessRequest()

Add a header to the HTTP request. In the example we add the api token key we need to use to access the Rest API.

HttpRequest = SimLabUtils:NewHttpRequest()
HttpRequest:AddHeader("api_key", "9s8ahg9as8hasdg8kavkch")

Set the endpoint for the HTTP request. In the example we set the URI of the currency exchange API as our endpoint.

HttpRequest = SimLabUtils:NewHttpRequest()
HttpRequest:SetEndpoint("http://api.apilayer.com/exchangerates_data/timeser
ies?start_date=2020-08-01")

Set the HTTP verb (e.g., GET, POST) for the request.

HttpRequest = SimLabUtils:NewHttpRequest()
HttpRequest:SetVerb("GET")
HttpRequest:SetEndpoint("http://api.apilayer.com/exchangerates_data/timeser
ies?start_date=2020-08-01")

Returns a reference of a JSON object containing the body of the response from the endpoint. In the example we assume we did the steps for OnResponse and we received a response from the endpoint.

function OnResponse()
   print("Response received")
   HttpResponse = HttpRequest:GetResponse()
end

Event handler for the HTTP request response. Assigns the function we want to call once we receive a reply to our HTTP request. In the example we assign the OnResponse function defined as the delegate function to call once we receive a reply after sending the HTTP request. Parameters for Add are:

• HttpObject : HTTP Object - Reference of HTTP object created to send HTTP request.
• ResponseDelegate : Function Name - Reference of function name to be called when we get a reply.

function OnResponse()
  print("Response received")
end

HttpRequest = SimLabUtils:NewHttpRequest()
HttpRequest:SetVerb("GET")
HttpRequest:SetEndpoint("http://api.apilayer.com/exchangerates_data/timeser
ies?start_date=2020-08-01")
HttpRequest.OnResponse:Add(HttpRequest, OnResponse)

Adds a new string field to the JSON structure. In the example we added a username field with its value.

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetStringField("username", "SimLab123")

Adds a new number field to the JSON structure. In the example we added an age field with its value.

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetNumberField("age", 21)

Adds a new boolean field to the JSON structure. In the example we added an in-stock field with its value.

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetBoolField("instock", true)

Adds a new JSON object field to the JSON structure. In the example we added a set of usernames in a new field with its values.

Usernames = SimLabUtils:NewJsonObject()
Usernames:SetStringField("username", "SimLab123")

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetObjectField("Usernames", Usernames)

Set an array field in the JSON object.

JsonArray1 = {JSONVal1, JSONVal2, JSONVal3}
local OutJSONArray1 = SimLabUtils:NewJsonValue()
OutJSONArray1:SetArray(JsonArray1)

JsonArray = {OutJSONArray1, OutJSONArray1}

local JsonArg = SimLabUtils:NewJsonObject()
JSON_Object:SetArrayField("array_arg", JsonArray)

Get a string field from the JSON object.

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetStringField("username", "SimLab123")

username = JSON_Object:GetStringField("username")

Get a number field from the JSON object.

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetNumberField("age", 21)

age = JSON_Object:GetNumberField("age")

Get a boolean field from the JSON object.

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:GetBoolField("instock", true)

IsInStock = JSON_Object:GetNumberField("instock")

Get a JSON Object field from the JSON object.

Usernames = SimLabUtils:NewJsonObject()
Usernames:SetStringField("username", "SimLab123")

JSON_Object = SimLabUtils:NewJsonObject()
JSON_Object:SetObjectField("Usernames", Usernames)

UsernamesSet = JSON_Object:GetObjectField("Usernames")

Returns an Array Referencing all JSON Objects inside the specified field.

local Iterate = RestAPI:GetResponse()
local IterateData = Iterate:GetArrayField("data")

Returns a string containing the whole JSON object body.

Usernames = SimLabUtils:NewJsonObject()
Usernames:SetStringField("username", "SimLab123")

JsonString = JSON_Object:ToString()

Returns a Float value containing the contents of the specified index from the JSON Value array.

local IterateData = Iterate:GetArrayField("data")
local FirstIndex = IterateData[1]:AsNumber()

Returns a String value containing the contents of the specified index from the JSON Value array.

local IterateData = Iterate:GetArrayField("data")
local FirstIndex = IterateData[1]:AsString()

Returns a Boolean value containing the contents of the specified index from the JSON Value array.

local IterateData = Iterate:GetArrayField("data")
local FirstIndex = IterateData[1]:AsBool()

Returns an Array of JSON Values containing the contents of the specified index from the JSON Value array.

local IterateData = Iterate:GetArrayField("data")
local FirstIndex = IterateData[1]:AsArray()

Returns a JSON Object containing the contents of the specified index from the JSON Value array.

• any: Will throw an error if this is not a JSON object.

local IterateData = Iterate:GetArrayField("data")
local FirstIndex = IterateData[1]:AsObject()

Set this value as a string.

local JSONVal1 = SimLabUtils:NewJsonValue()
JSONVal1:SetString("data")

Set this value as a number.

local JSONVal1 = SimLabUtils:NewJsonValue()
JSONVal1:SetNumber(200)

Set this value as a boolean.

local JSONVal1 = SimLabUtils:NewJsonValue()
JSONVal1:SetBool(true)

Set this value as an array of JSON values.

local JSONVal1 = SimLabUtils:NewJsonValue()
JSONVal1:SetObject(JsonArg11)

local JSONVal2 = SimLabUtils:NewJsonValue()
JSONVal2:SetObject(JsonArg12)

local JSONVal3 = SimLabUtils:NewJsonValue()
JSONVal3:SetObject(JsonArg13)

JsonArray1 = {JSONVal1, JSONVal2, JSONVal3}
local OutJSONArray1 = SimLabUtils:NewJsonValue()
OutJSONArray1:SetArray(JsonArray1)

Set this value as a JSON object.

local JsonArg11 = SimLabUtils:NewJsonObject()
JsonArg11:SetStringField("name", "reem1")
JsonArg11:SetStringField("gender", "Femail1")
JsonArg11:SetStringField("job_title", "Software engineer1")

local JSONVal1 = SimLabUtils:NewJsonValue()
JSONVal1:SetObject(JsonArg11)

Get the name of the material.

-- Assuming Node1 exists
local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your SceneNode.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   print(BoxMaterial:GetMaterialName())
else
   print("Node not found")
end

Get the type of the material.

-- Assuming Node1 exists
local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your SceneNode.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   print(BoxMaterial:GetMaterialType())
else
   print("Node not found")
end

Set the Linear color of the material.

local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your SceneNode.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   BoxMaterial:SetMaterialColor(UE.FLinearColor(1, 0, 0)) --FLinearColor(Red, Green, Blue) Values Between 0 and 1.
else
   print("Node not found")
end

Get the color of the material.

-- Assuming Node exists
local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   local Color = BoxMaterial:GetMaterialColor()
   Color.R = math.random() --Random value for Color.Red
   Color.B = math.random() --Random value for Color.Blue
   print(tostring(Color))
   BoxMaterial:SetMaterialColor(Color)
else
  print("Node not found")
end

Set the alpha (transparency) of the material.

-- Assuming Node exists 
local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
local BoxMaterial = Box:GetMaterial()
BoxMaterial:SetMaterialAlpha(0.5) --50% opacity

Get the alpha (transparency) of the material.

-- Assuming Node exists
local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   local Alpha = BoxMaterial:GetMaterialAlpha()
   print(Alpha)

else
   print("Node not found")
end

Set Density of Physical Material Data in Material.

-- Assuming Node exists
local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1] 
if Box then
   local BoxMaterial = Box:GetMaterial()
   BoxMaterial:SetDensity(0.5)
else
   print("Node not found")
end

Get Density of Physical Material Data in Material.

-- Assuming Node exists 
local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   local Density = BoxMaterial:GetDensity()
   print(Density)
else
   print("Node not found")
end

Set the friction of Physical Material Data in Material.

local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   BoxMaterial:SetFriction(0.5)
else
   print("Node not found")
end

Get the friction of Physical Material Data in Material.

local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   local Friction = BoxMaterial:GetFriction()
   print(Friction)
else
   print("Node not found")
end

Set the restitution (bounce) of Physical Material Data in Material.

local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   BoxMaterial:SetRestitution(0.5)
else
   print("Node not found")
end

Get the restitution (bounce) of Physical Material Data in Material.

local Boxs = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your 3DObject.
local Box = Boxs[1]
if Box then
   local BoxMaterial = Box:GetMaterial()
   local Restitution = BoxMaterial:GetRestitution()
   print(Restitution)
else
   print("Node not found")
end

Copy material preoperties from OtherMaterial.

Creates a copy of this material.

Activate the quiz associated with this node.

--Assuming QuizButton node exists
local Nodes = SimLabUtils:FindNodesByName("QuizButton") 
Nodes[1]:ActivateQuiz()

Get the name of the scene state.

local SceneStates = SimLabUtils:FindSceneStatesByName("Mid") -- Replace "Mid" with the name of your scene state.
local SceneState = SceneStates[1]

print(SceneState:GetSceneStateName())

Apply the scene state.

local SceneStates = SimLabUtils:FindSceneStatesByName("Mid") -- Replace "Mid" with the name of your scene state.
local SceneState = SceneStates[1]

SceneState:Apply()

Get the name of the animation sequence.

-- Assuming Sequence_1 exits
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

print(Sequence:GetSequenceName())

Check if the animation sequence is looping.

-- Assuming Sequence_1 exits
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence:IsLooping() then 
   print("The Animation is looping")
else
   print("The Animation is NOT looping")  
end

Set whether the animation sequence is looping.

-- Assuming Sequence_1 exits
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence:IsLooping() then 
   print("Animation looping:True")
else
   Sequence:SetIsLooping(true)
   print("Animation looping:False->True")
end

Check if the animation sequence is swinging.

-- Assuming Sequence_1 exits
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

print(tostring(Sequence:IsSwinging()))

Set whether the animation sequence is swinging.

-- Assuming Sequence_1 exits
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:SetIsSwinging(true)

Set the play rate of the animation sequence.

-- Assuming Sequence_1 exits
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence then
   Sequence:SetPlayRate(0.5)
else
   print("Sequence NOT found")

Get the play rate of the animation sequence.

-- Assuming Sequence_1 exits
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence then
	  PlayRate = Sequence:GetPlayRate()
	  print(tostring(PlayRate))
else
   print("Sequence not found")
end

Get the start frame of the full animation range.

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence then
   print(Sequence:GetFullRangeStartFrame())
else
   print("Sequence not found")
end

Get the end frame of the full animation range.

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence then
   print(Sequence:GetFullRangeEndFrame())
else
   print("Sequence not found")
end

Set the play range of the animation sequence.

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with name of your sequence.
local Sequence = Sequences[1]
if Sequence then
   local Start =Sequence:GetFullRangeStartFrame()
   local End = Sequence:GetFullRangeEndFrame()
   Sequence:SetPlayRange(Start, End)
   print(End-Start)
else
   print("Sequence not found")
end

Get the start frame of the play range.

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence then
   print(Sequence:GetPlayRangeStartFrame())
else
   print("Sequence not found")
end

Get the end frame of the play range.

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence then
   print(Sequence:GetPlayRangeEndFrame())
else 
   print("Sequence not found")
end

Start playing the animation from the beginning.

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:PlayFromStart()

Start playing the animation from the current frame.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:Play()

Continue playing the animation from the current frame.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:Continue()

Reverse the animation from the current frame.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:Reverse()

Reverse the animation from the end frame.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:ReverseFromEnd()

Flip the direction of the animation from the current frame.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:Flip()

Stop playing the animation.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequence:Stop()

Seek to a specific frame in the animation.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

Sequnce:Seek(54.555)

Check if the animation is currently playing.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence:IsPlaying() then
   Sequence:Stop()
   print("Playing -> Stop")
else
   Sequence:PlayFromStart()
   print("Stop -> Playing")
end

Check if the animation is currently reversing.

-- Assuming Sequence_1 exists
local Sequences = SimLabUtils:FindSequencesByName("Sequence_1") -- Replace "Sequence_1" with the name of your sequence.
local Sequence = Sequences[1]

if Sequence:IsReversing() then
   Sequence:Stop()
   print("Reversing -> Stop")
else
   Sequence:ReverseFromEnd()
   print("Stop -> Reversing")
end

Get the parent node of this transform node.

-- Assuming node exists
local node = SimLabUtils:FindNodesByName("node_1") -- Replace "node_1" with the name of your SceneNode.

if node[1] then
   local parentNode = node[1]:GetParentNode()
   print(parentNode:GetNodeName())
else 
   print("node not Found !")
end

Get the initial parent node of this transform node.

-- Assuming node exists
local node = SimLabUtils:FindNodesByName("node_1") -- Replace "node_1" with the name of your SceneNode.

if node[1] then 
   local initialParentNode = node[1]:GetInitialParentNode()
   print(initialParentNode:GetNodeName())
else 
   print("node not Found !")
end

Set the parent node of this transform node.

-- Assuming childNode and parentNode exists
local childNode = SimLabUtils:FindNodesByAttribute("child") -- Replace "child" with the Attribute of your child SceneNode.
local parentNode = SimLabUtils:FindNodesByAttribute("parent") -- Replace "parent" with the Attribute of your parent SceneNode. 

childNode[1]:SetParentNode(parentNode[1]) --InAttachRules:"KeepWorld" is Default if not assigned
print(parentNode[1]:GetNodeName())

Set the parent node of this transform node.

-- Assuming node exists
local childNode = SimLabUtils:FindNodesByAttribute("child") -- Replace "child" with the Attribute of your child SceneNode.
local parentNode = SimLabUtils:FindNodesByAttribute("parent") -- Replace "parent" with the Attribute of your parent SceneNode. 
childNode[1]:SetParentNode(parentNode[1],"KeepWorld")
--InAttachRules Types:(Default:"KeepWorld", "KeepRelative", "SnapToTargetWithScale", "SnapToTarget")
print(parentNode[1]:GetNodeName())

Reset this node to its initial parent node.

-- Assuming node exists
local nodes = SimLabUtils:FindNodesByName("node_1")
local node = nodes[1]
if node then
   node:ResetToInitialParentNode()--InAttachRules Types:(Default:"KeepWorld", "KeepRelative", "SnapToTargetWithScale", "SnapToTarget")
   print(node:GetInitialParentNode():GetNodeName())
else
   print("node not Found !")
end

Get a set of children nodes of this transform node.

-- Assuming Parent exists
local Nodes = SimLabUtils:FindNodesByName("Parent")
local children = Nodes[1]:GetChildrenNodes()
for counter, child in ipairs(children) do
   print("Child " .. counter, child)
end

Get a set of descendant nodes of this transform node (children and children's children).

-- Assuming Parent exists
local Nodes = SimLabUtils:FindNodesByName("Parent") -- Replace "Parent" with the name of your SceneNode.
local descendants = Nodes[1]:GetDescendantNodes()
for counter, child in ipairs(descendants) do
   print("descendant " .. counter, child)
end

Get an array of ancestor nodes of this transform node.

local Nodes = SimLabUtils:FindNodesByName("3DBox") -- Replace "3DBox" with the name of your SceneNode.
local Ancestors =Nodes[1]:GetAncestorNodes()
for counter, Ancestor in ipairs(Ancestors) 
   do print("Ancestor " .. counter, Ancestor:GetNodeName())
end

Get the name of this transform node.

-- Assuming node exists
local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
local Box = Nodes[1]

print(Box:GetNodeName())

Get an attribute of this transform node by name.

-- Assuming node Box exists
local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
local Box = Nodes[1]
local AttriblueValue = Box:GetNodeAttribute("test") -- Replace "test" with the name of your Attribute.
print(AttriblueValue)

Get an attribute from a specific category of this transform node by name.

-- Assuming node Box exists
local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
local Node = Nodes[1]
local AttriblueValue = Node:GetNodeAttributeFromCategory("Name","Category")
print(AttriblueValue)

Set an attribute of this transform node by name.

-- Assuming Box exists
local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
Node =Nodes[1]
local attributeName = "Color"
local attributeValue = "Red"

Node:SetNodeAttribute(attributeName, attributeValue)
print(Node:GetNodeAttribute(attributeName))

SetNodeAttributeInCategory(attributeName, attributeValue, Category) Set an attribute in a specific category of this transform node by name.

* -- Assuming Box exists
local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
Node =Nodes[1]
local attributeName = "Color"
local attributeValue = "Red"
local Category = "Appearance"

Node:SetNodeAttributeInCategory(attributeName, attributeValue,Category)
print(Node:GetNodeAttributeFromCategory(attributeName,Category))

Check if this transform node has a specific attribute by name.

local node = SimLabUtils:FindNodesByName("Name") -- Replace "Name" with the name of your SceneNode.
local hasAttribute = node[1]:NodeHasAttribute("test") -- Replace "test" with the name of your Attribute.

print(tostring(hasAttribute))

Check if this transform node has an attribute in a specific category by name.

-- Assuming node attriblue exists
local nodes = SimLabUtils:FindNodesByName("Name") -- Replace "Name" with the name of your SceneNode.
local attributeName = "Color"
local attributeCategory = "Visuals"

local hasAttributeInCategory = nodes[1]:NodeHasAttributeInCategory(attributeName, attributeCategory)
print(hasAttributeInCategory)

Set the glow state of this node.

-- Assuming Box exists
local node = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
node[1]:SetNodeGlowState(true)

print("Node glow state set to enabled.")

Make this node glow.

-- Highlight first Box
nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
if nodes[1] then
   nodes[1]:GlowNode()
else
   print("Node Has Not Found")
end

Stop glowing this node.

-- Assuming Box exists
local node = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.

node[1]:StopGlowNode()
print("Node glow Stopped.")

Check if this node is currently glowing.

-- Assuming Box exists
local node = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
if node[1]:IsNodeGlowing() then
   print("true")
else
   print("false")
end

Set the visibility state of this node.

-- Hide first Box
local node = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode.
if node[1] then
   node[1]:SetNodeVisibility(false)
else 
   print("Node Not Found")
end

Check if this node is currently visible.

local node = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your node.

-- Check if the node is currently visible
local isVisible = node[1]:IsNodeVisible()

print("Is the node visible? " .. tostring(isVisible))

Show this node.

local node = SimLabUtils:FindNodesByName("node_1") -- Replace "node_1" with the name of your node.
if node then
   node[1]:ShowNode()
   print("Node is now visible.")
else
  print("Node Not Found")
end

Hide this node.

local node = SimLabUtils:FindNodesByName("node_1") -- Replace "node_1" with the name of your node.

if node then
   node[1]:HideNode()
   print("Node is now hidden.")
else
  print("Node Not Found.")
end

Delete this node.

local Nodes = SimLabUtils:FindNodesByName("Name") -- Replace "Name" with the name of your node. 

if Nodes then
   Nodes[1]:DeleteNode()
   print("Node has been deleted.")
else
  print("Node Not Found.")
end

Make Instance of this node.

-- Assuming Node_1 exists
local Nodes = SimLabUtils:FindNodesByName("Node_1") -- Replace "Node_1" with the name of your node. 
local Node = Nodes[1]

local NodeCopy = Node:MakeNodeInstance()

Make copy of this node.

-- Assuming Node_1 exists
local Nodes = SimLabUtils:FindNodesByName("Node_1") -- Replace "Node_1" with the name of your node. 
local Node = Nodes[1]

local NodeCopy = Node:MakeNodeCopy()

Get the global transform of this node.

local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode. 
local Box = Nodes[1]

Box:AnimatedSetNodeLocalLocation(UE.FVector(0.5), 1)
Box:AnimatedSetNodeLocalScale(UE.FVector(0.2), 1)
Box:AnimatedSetNodeLocalRotation(UE.FRotator(0, -90 , 0), 0.3)
local WorldTransform = Box:GetNodeGlobalTransform()
print(tostring(WorldTransform))

Get the local transform of this node.

local Nodes = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode. 
local Pyramid =Nodes[1]

Pyramid:AnimatedSetNodeLocalLocation(UE.FVector(0.5), 1)
Pyramid:AnimatedSetNodeLocalScale(UE.FVector(0.2), 1)
Pyramid:AnimatedSetNodeLocalRotation(UE.FRotator(0, -90 , 0), 0.3)
local WorldTransform = Pyramid:GetNodeLocalTransform()
print(tostring(WorldTransform))

Get the initial global transform of this node when the scene started.

-- Assuming node name is  "Box"
local node = SimLabUtils:FindNodesByName("Box") -- Replace "Box" with the name of your SceneNode. 

-- Get the initial global transform of the node
local initialGlobalTransform = node[1]:GetInitialGlobalTransform()

-- Print the initial global transform matrix
print(tostring(initialGlobalTransform))

Set the global transform of this node.

local node = SimLabUtils:FindNodesByName("Box")

-- Get the initial global transform of the node
local nodeTransform = node[1]:GetInitialGlobalTransform()

node[1]:SetNodeGlobalTransform(nodeTransform)

print("Node's Global transform has been set.")

Set the relative transform of this node.

local node = SimLabUtils:FindNodesByName("node_1")

-- Get the local transformation of the node
local WorldTransform = node[1]:GetNodeLocalTransform()

-- Set node transformation
node[1]:SetNodeLocalTransform(transformMatrix)
-- Print confirmation
print("Node's Local transform has been set.")

Animate setting the global transform of this node.

-- Assuming node exists
local node = SimLabUtils:FindNodesByName("Box")
local node2 = SimLabUtils:FindNodesByName("Box2")

-- Create a transformation matrix for the target transform
local targetTransform = node2[1]:GetNodeGlobalTransform()

-- Set the animation duration in seconds
local duration = 3.0  -- 3 seconds for the transformation to complete

-- Apply the animated global transform to the node
node[1]:AnimatedSetNodeGlobalTransform(targetTransform, duration)

-- Print confirmation
print("Node's global transform is animating over " .. duration .. " seconds.")

Animate setting the local transform of this node.

-- Create a new node object
local node = SimLabUtils:FindNodesByName("Box")
local node2 = SimLabUtils:FindNodesByName("Box")

-- Create a transformation matrix for the target transform
local targetTransform = node2[1]:GetNodeGlobalTransform()

-- Set the animation duration in seconds
local duration = 3.0  -- 3 seconds for the transformation to complete

-- Apply the animated local transform to the node
node[1]:AnimatedSetNodeLocalTransform(targetTransform, duration)

-- Print confirmation
print("Node's Local transform is animating over " .. duration .. " seconds.")

Get the global location of this node.

local node = SimLabUtils:FindNodesByName("node_1")

-- Get the global location of the node
local globalLocation = node[1]:GetNodeGlobalLocation()

-- Print the global location (x, y, z)
print("Node's global location: " .. tostring(globalLocation))

Get the local location of this node.

local node = SimLabUtils:FindNodesByName("node_1")

-- Get the local location of the node
local localLocation = node[1]:GetNodeLocalLocation()

-- Print the local location (x, y, z)
print("Node's local location: " .. tostring(localLocation))

Set the global location of this node.

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Box = Nodes[1]

local Player = SimLabUtils:GetFirstPlayerController()
-- Assuming there is a camera in the scene
local CameraTransform = Player:GetCameraTransform() 

local CameraRotation = CameraTransform.Rotation
local CameraLocation = CameraTransform.Translation

local ForwardVector = CameraRotation:GetForwardVector()
local NewLocation = CameraLocation + ForwardVector * -3;

local BoxCopy = Box:MakeNodeCopy()

print(tostring(NewLocation))
BoxCopy:SetNodeGlobalLocation(NewLocation)

Set the local location of this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
if Nodes then
   local Box = Nodes[1]
   local locallocation = Box:SetNodeLocalLocation(UE.FVector(0.5))
else
   print("Node Not Found")
end

Make this node fall to the surface.

-- Make first Box fall to the surface
local node = SimLabUtils:FindNodesByName("Box")
node[1]:FallToSurface()

Animate making this node fall to the surface.

-- Assuming Node_1 exists
local node = SimLabUtils:FindNodesByName("node_1")

-- Set the duration for the fall animation
local duration = 2.0  -- Fall over 2 seconds

-- Apply the animated fall to the surface
node[1]:AnimatedFallToSurface(duration)

-- Print confirmation
print("Node is animating a fall to the surface over " .. duration .. " seconds.")

Animate setting the global location of this node.

-- Create a new node object
local node = SimLabUtils:FindNodesByName("Box")
local node2 = SimLabUtils:FindNodesByName("Box2")

-- Create a transformation matrix for the target transform
local targetTransform = node2[1]:GetNodeGlobalLocation()

-- Set the animation duration in seconds
local duration = 3.0  -- 3 seconds for the transformation to complete

 -- Apply the animated global location to the node
node[1]:AnimatedSetNodeGlobalLocation(targetTransform, duration)

   -- Print confirmation
print("Node's global transform is animating over " .. duration .. " seconds.")

Animate setting the local location of this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
if Nodes then
   local Box = Nodes[1]
   Box:AnimatedSetNodeLocalLocation(UE.FVector(0.5))
else
   print("Node Not Found")
end

Get the global rotation of this node.

local node = SimLabUtils:FindNodesByName("Box")

-- Get the global Rotation of the node
local globalRotation = node[1]:GetNodeGlobalRotation()

-- Print the global Rotation (x, y, z)
print("Node's global Rotation: " .. tostring(globalRotation))

Get the local rotation of this node.

-- Assuming node Box exists
local node = SimLabUtils:FindNodesByName("Box")

-- Get the local Rotation of the node
local localRotation = node[1]:GetNodeLocalRotation()

-- Print the local Rotation (x, y, z)
print("Node's local Rotation: " .. tostring(localRotation))

Set the global rotation of this node.

local Nodes = SimLabUtils:FindNodesByAttribute("Name") -- Replace "Name" with the name of your attribute
local Box= Nodes[1]

local Player = SimLabUtils:GetFirstPlayerController()
local CameraTransform = Player:GetCameraTransform()
local CameraRotation = CameraTransform.Rotation

local BoxCopy = Box:MakeNodeCopy()
BoxCopy:SetNodeGlobalRotation(CameraRotation:ToRotator())

Set the local rotation of this node.

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Box=Nodes[1]
Box:SetNodeLocalRotation(UE.FRotator(0, -90 , 0))

Reset the node's rotation to its initial scene state.

-- Reset first Box Rotation
local node = SimLabUtils:FindNodesByName("Box")
local Box  = node[1]
Box:MakeNodeGrabbable(true)
Box:ResetRotation('ALL') -- (Default:"All", "Up")

Animate setting the global rotation of this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
local Box = Nodes[1]

local Player = SimLabUtils:GetFirstPlayerController()
local CameraTransform = Player:GetCameraTransform()
local CameraRotation = CameraTransform.Rotation

local BoxCopy = Box:MakeNodeInstance()
BoxCopy:AnimatedSetNodeGlobalRotation(CameraRotation:ToRotator(), 5, false)

Animate setting the local rotation of this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
local Box = Nodes[1]

local Player = SimLabUtils:GetFirstPlayerController()
local CameraTransform = Player:GetCameraTransform()
local CameraRotation = CameraTransform.Rotation

local BoxCopy = Box:MakeNodeInstance()
BoxCopy:AnimatedSetNodeLocalRotation(UE.FRotator(0, -90 , 0), 0.3)

Get the global scale of this node.

local node = SimLabUtils:FindNodesByName("Box")

-- Get the global location of the node
local GlobalScale = node[1]:GetNodeGlobalScale()

-- Print the global Scale (x, y, z)
print("Node's global Scale: " .. tostring(GlobalScale))

Get the local scale of this node.

local node = SimLabUtils:FindNodesByName("Box")

-- Get the local location of the node
local localScale = node[1]:GetNodeLocalScale()

-- Print the local Scale (x, y, z)
print("Node's local Scale: " .. tostring(localScale))

Set the global scale of this node.

local node = SimLabUtils:FindNodesByName("Box")
node[1]:SetNodeGlobalScale(node[1]:GetNodeGlobalScale()*1.3) -- Set the box global scale to 130%

Set the local scale of this node.

local node = SimLabUtils:FindNodesByName("Box")
node[1]:SetNodeLocalScale(node[1]:SetNodeLocalScale()*1.3) -- Set the box local scale to 130%

Animate setting the global scale of this node over duration of time.

local node = SimLabUtils:FindNodesByName("Box")
-- Animate the box global scale to 130% over duration 3 seconds
node[1]:AnimatedSetNodeGlobalScale(node[1]:GetNodeGlobalScale()*1.3 , 3)

Animate setting the local scale of this node.

local node = SimLabUtils:FindNodesByName("Box")
-- Animate the box local scale to 130% over duration 3 seconds
node[1]:AnimatedSetNodeLocalScale(node[1]:GetNodeGlobalScale()*1.3 , 3)

Cancel grabbing this node.

local node = SimLabUtils:FindNodesByName("Box")
node[1]:CancelNodeGrab()
print("The grab action for the node has been canceled.")

Make this node grabbable or ungrabbable.

local Nodes = SimLabUtils:FindNodesByName("Box")
local Box = Nodes[1]

Box:MakeNodeGrabbable(true) -- default is true

Set the grabbable sequence for this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
local Box = Nodes[1]
local Sequneces = SimLabUtils:FindSequencesByName("Right")
local Sequence = Sequences[1]

Box:SetGrabbableSequence(Sequence)

Show a message box on this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
title = "Test"
body = "Hello World!"
Nodes[1]:ShowMessageBox(title, body)

Check if a message box is currently shown on this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
if Nodes[1]:IsMessageBoxShown() then
	print("A message box is currently being displayed.")
else
	print("No message box is being displayed.")
end

Hide the message box on this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
if Nodes[1]:IsMessageBoxShown() then
	Nodes[1]:HideMessageBox()
else
	print("No message box is shown.")
end

Set simulate physics to node (has to be 3D Object and enabled physics in SimLab).

local Nodes = SimLabUtils:FindNodesByName("Box")
local Box = Nodes[1]

Box:SetNodeSimulatePhysics(true)

Check if simulate physics is enabled for this node.

local Nodes = SimLabUtils:FindNodesByName("Box")
local Box = Nodes[1]

local IsSimulatePhysics = Box:IsNodeSimulatingPhysics()
print(tostring(IsSimulatePhysics))

Align two identical nodes to each other (useful for animations with physics illusion).

local Nodes = SimLabUtils:FindNodesByName("Box")
local Box = Nodes[1]
local Nodes2 = SimLabUtils:FindNodesByName("Box2")
local Box2 = Nodes2[1]

Box:AlignNodeTo(Box2)

The name of the variable.

Type: string

local myVariable = 10
local _anotherVar = "Hello"

The type name of the variable.

Type: string

local myNum = 42
print(type(myVar))  -- Output: "number"
local myStr = "test"
print(type(myStr))  -- Output: "string"

Change the variable's value by expression using Lua syntax.

local myVar = 10
print("Node's variable value before change: " .. myVar)

myVar = 20
print("Node's variable value after change : " .. myVar)

Toggle the playback state of the video.

local nodes = SimLabUtils:FindNodesByName("video")
node = nodes[1]
if node then
   video =node:GetMaterial()
   video:ToggleState()  -- Call the method to toggle the state
   print("Node's state has been toggled.")
else
    print("Node not found.")
end

Start playing the video.

local nodes = SimLabUtils:FindNodesByName("video")
node = nodes[1]
if node then
   video =node:GetMaterial()
   video:Play()

Stop the video playback.

local nodes = SimLabUtils:FindNodesByName("video")
node = nodes[1]
if node then
   video =node:GetMaterial()
   video:Stop()

Seek to a specific time in the video playback.

local nodes = SimLabUtils:FindNodesByName("video")
node = nodes[1]
if node then
   video =node:GetMaterial()
   video:Seek(5) -- Seek to 5 seconds

Play the video for a specified duration.

local nodes = SimLabUtils:FindNodesByName("video")
node = nodes[1]
if node then
   video =node:GetMaterial()
   video:PlayDuration(10) -- Play for 10 seconds

Check if orientation is applied when teleporting to the camera.

-- Assuming node_1 exists
local node = SimLabUtils:FindNodesByName("node_1")

if node then
    local applyOrientation = node[1]:IsApplyOrientation()  -- Check if orientation is applied
    if applyOrientation then
        print("Orientation is applied when teleporting to the camera.")
    else
        print("Orientation is not applied when teleporting to the camera.")
    end
else
    print("Node not found.")
end

Get the teleport location of the camera.

-- Assuming node_1 exists
local node = SimLabUtils:FindNodesByName("node_1")

if node then
    local teleportLocation = node[1]:GetTeleportLocation()  -- Get the teleport location
    print("Teleport location of the camera is:")
    print("X: " .. teleportLocation.x)
    print("Y: " .. teleportLocation.y)
    print("Z: " .. teleportLocation.z)
else
    print("Node not found.")
end

Get the teleport rotation of the camera.

-- Assuming node_1 exists
local node = SimLabUtils:FindNodesByName("node_1")

if node then
    local teleportRotation = node[1]:GetTeleportRotation()  -- Get the teleport rotation
    print("Teleport rotation of the camera is:")
    print("Pitch: " .. teleportRotation.pitch)
    print("Yaw: " .. teleportRotation.yaw)
    print("Roll: " .. teleportRotation.roll)
else
    print("Node not found.")
end