| Documentation

USimLabLuaManager ▸
- Instance members
- #FindNodesByName
- #FindNodesByAttribute
- #FindSequencesByName
- #FindSceneStatesByName
- #OpenVRPackage
- #ImportVRPackage
- #GetVariableByName
- #GetFirstPlayerController
- #NewHttpRequest
- #NewJsonObject
- #NewJsonValue
- #print
ASimLab3DObjectNode ▸
- Instance members
- #GetMaterial
- #SetMaterial
ASimLab3DSoundNode ▸
- Instance members
- #ToggleState
- #Play
- #Stop
- #Seek
- #PlayDuration
ASimLabController ▸
- Instance members
- #GetCameraTransform
- #GetAttributeValue
- #PointToNode
- #RemovePointToNode
- #TeleportToView
- #TeleportToLocation
USimLabLuaHttpRequest ▸
- Instance members
- #SetRequestBody
- #ProcessRequest
- #AddHeader
- #SetEndpoint
- #SetVerb
- #GetResponse
- Events
- ⓔ FOnLuaHttpRequestResponse
USimLabLuaJsonObject ▸
- Instance members
- #SetStringField
- #SetNumberField
- #SetBoolField
- #SetObjectField
- #SetArrayField
- #GetStringField
- #GetNumberField
- #GetBoolField
- #GetObjectField
- #GetArrayField
- #ToString
USimLabLuaJsonValue ▸
- Instance members
- #AsNumber
- #AsString
- #AsBool
- #AsArray
- #AsObject
- #SetString
- #SetNumber
- #SetBool
- #SetArray
- #SetObject
ASimLabMaterial ▸
- Instance members
- #GetMaterialName
- #GetMaterialType
- #SetMaterialColor
- #GetMaterialColor
- #SetMaterialAlpha
- #GetMaterialAlpha
ASimLabSceneState ▸
- Instance members
- #SetDensity
- #GetDensity
- #SetFriction
- #GetFriction
- #SetRestitution
- #GetRestitution
- #GetSceneStateName
- #Apply
ASimLabQuizNode ▸
- Instance members
- #ActivateQuiz
ASimLabAnimationSequence ▸
- Instance members
- #GetSequenceName
- #SetIsLooping
- #IsLooping
- #SetIsSwinging
- #IsSwinging
- #SetPlayRate
- #GetPlayRate
- #GetFullRangeStartFrame
- #GetFullRangeEndFrame
- #SetPlayRange
- #GetPlayRangeStartFrame
- #GetPlayRangeEndFrame
- #PlayFromStart
- #Play
- #Continue
- #Reverse
- #ReverseFromEnd
- #Flip
- #Stop
- #Seek
- #IsPlaying
- #IsReversing
ASimLabTransformNode ▸
UEventsVariable ▸
- Instance members
- #Name
- #TypeName
- #ValueFromString
- #ValueToString
- #ChangeVariableValue
- #SetStringValue
- #SetNumberValue
- #SetNumberValue
- #SetIntegerValue
- #UpdateTimeValue
ASimLabVideoMaterial ▸
- Instance members
- #ToggleState
- #Play
- #Stop
- #Seek
- #PlayDuration
ASimLabVRCamera ▸
- Instance members
- #IsApplyOrientation
- #GetTeleportLocation
- #GetTeleportRotation

Lua Scripting for SimLab Training Builder

SimLab Composer’s Training Builder uses Lua scripting language. Our API allows users to create Lua scripts for their specific needs, making the tool a dynamic platform for creativity and innovation.

For Advanced Users

Lua scripting in SimLab Training Builder enables advanced users to create complex, feature-rich experiences beyond default capabilities. It allows precise customization of training scenarios with unique functionalities for immersive outcomes, offering limitless creativity.

A Proper License

Lua Scripting is only available in the Ultimate edition of SimLab Composer 12.1 or later and is not included in SimLab VR Studio.

The ‘Run Script’ Node

To execute a Lua script in SimLab Training Builder, create a ‘Run Script’ node graph by right-clicking and selecting ‘Run Script’. This node allows Lua script input and must be linked into your graph execution flow.

The `print` Function

The print("Hello World!") function is crucial for script writing and testing in Lua. It tracks data flow and variable states, aids in issue identification, and acts as a simple logging system for debugging and understanding code behavior.

Key Syntax Rules in Lua Programming

Case sensitivity: Lua is a case-sensitive language. This means that Variable, variable, and VARIABLE are all considered different identifiers in Lua.
Termination: In Lua, it’s not necessary to use a ; at the end of each statement.
Commenting: To comment out a single line, place -- at the start of the line. For commenting out multiple lines, start with --[[ on the first line and end with ]] on the final line.
Array Indexing: In Lua, the convention is to start arrays with an index of 1. However, you can technically start an array at index 0, 1, or any other value. But if you stick to the convention of starting arrays with index 1, you will be able to use Lua’s libraries directly. So, while it’s possible to start an array at index 0, it’s generally more convenient to start at index 1.

Caution: Lua Scripting and SimLab VR Viewer Stability

Please be aware that improper use of Lua scripting can lead to unexpected crashes in SimLab VR Viewer. Always test your scripts thoroughly before running them in production. If you encounter consistent crashes, consider reaching out to the SimLab community or support for assistance. Your understanding and caution are appreciated. Happy scripting!

Lua Scripting Tutorials: From Beginner to Beyond

Beginner: Jump in to execute your initial script in a step-by-step manner.
Intermediate: Retrieve weather information and reflect it in an experience.
Advanced: Create a Flask server.

Links to Relative External Resources:

USimLabLuaManager

Represents a Lua Manager for SimLab VR Viewer.

new USimLabLuaManager()

Instance Members

▸ FindNodesByName(InNodeName)

Find nodes in the scene by name.

FindNodesByName(InNodeName: string): Array<ASimLabTransformNode>

Parameters

InNodeName (string) The name of the nodes to search for.

Returns

Array<ASimLabTransformNode>: An array of nodes matching the given name.

Example

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

▸ FindNodesByAttribute(AttributeName)

Find nodes in the scene by attribute name.

FindNodesByAttribute(AttributeName: string): Array<ASimLabTransformNode>

Parameters

AttributeName (string) The name of the attribute to search for.

Returns

Array<ASimLabTransformNode>: An array of nodes with the specified attribute.

Example

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

▸ FindSequencesByName(InSequenceName)

Find animation sequences in the scene by name.

FindSequencesByName(InSequenceName: string): Array<ASimLabAnimationSequence>

Parameters

InSequenceName (string) The name of the animation sequences to search for.

Returns

Array<ASimLabAnimationSequence>: An array of animation sequences matching the given name.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:SetPlayRange(0, 100)

▸ FindSceneStatesByName(InSceneStateName)

Find scene states in the scene by name.

FindSceneStatesByName(InSceneStateName: string): Array<ASimLabSceneState>

Parameters

InSceneStateName (string) The name of the scene states to search for.

Returns

Array<ASimLabSceneState>: An array of scene states matching the given name.

Example

local SceneStates = SimLabUtils:FindSceneStatesByName("Mid")
local SceneState = SceneStates[1]

print(SceneState:GetSceneStateName())

SceneState:Apply()

▸ OpenVRPackage(Path)

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

OpenVRPackage(Path: string)

Parameters

Path (string) The path to the VR package.

Example

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

▸ ImportVRPackage(InPathOrUrl, InTransform)

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

ImportVRPackage(InPathOrUrl: string, InTransform: FTransform)

Parameters

InPathOrUrl (string) The path or URL of the VR package.

InTransform (FTransform) The transform to apply during import.

Example

-- Add box to scene
SimLabUtils:ImportVRPackage("C:/Box.vrpackage", UE.FTransform(UE.FRotator(0, 0, 0), UE.FVector(0, 0, 0), UE.FVector(1, 1, 1)))

▸ GetVariableByName(VariableName)

Get a variable by name.

GetVariableByName(VariableName: string): UEventsVariable

Parameters

VariableName (string) The name of the variable to retrieve.

Returns

UEventsVariable: The variable with the specified name.

Example

local NumVariable = SimLabUtils:GetVariableByName("num")
NumVariable:SetNumberValue(num + 2)

▸ GetFirstPlayerController()

Get the first player controller.

GetFirstPlayerController(): ASimLabController

Returns

ASimLabController: The first player controller.

Example

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

▸ NewHttpRequest()

Create a new HTTP request.

NewHttpRequest(): USimLabLuaHttpRequest

Returns

USimLabLuaHttpRequest: A new HTTP request object.

Example

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

▸ NewJsonObject()

Create a new JSON object.

NewJsonObject(): USimLabLuaJsonObject

Returns

USimLabLuaJsonObject: A new JSON object.

Example

-- New JSON object
JSON_Object = SimLabUtils:NewJsonObject()

▸ NewJsonValue()

Create a new JSON value.

NewJsonValue(): USimLabLuaJsonValue

Returns

USimLabLuaJsonValue: A new JSON value.

Example

-- New JSON value
local OutJSONArray1 = SimLabUtils:NewJsonValue()

▸ print(LogToPrint)

Print a log message to the screen.

print(LogToPrint: string)

Parameters

LogToPrint (string) The message to print to the log.

Example

print("This is a log message.")

ASimLab3DObjectNode

Represents a 3D Object Node in Lua.

new ASimLab3DObjectNode()

Instance Members

▸ GetMaterial()

Get the material associated with this object node.

GetMaterial(): ASimLabMaterial

Returns

ASimLabMaterial: The material for this object node.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()

▸ SetMaterial(NewMaterial)

Set the material for this object node.

SetMaterial(NewMaterial: ASimLabMaterial)

Parameters

NewMaterial (ASimLabMaterial) The new material to set.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local Nodes2 = SimLabUtils:FindNodesByName("3DSphere")
local Sphere = Nodes2[1]

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

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

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

ASimLab3DSoundNode

Represents a 3D Sound Node in Lua.

new ASimLab3DSoundNode()

Instance Members

▸ ToggleState()

Toggle the playback state of the sound.

ToggleState()

Example

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode")
SoundNodes[1]:ToggleState()

▸ Play()

Start playing the sound.

Play()

Example

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode")
SoundNode[1]:Play()

▸ Stop()

Stop the sound playback.

Stop()

Example

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode")
SoundNodes[1]:Stop()

▸ Seek(InTime)

Seek to a specific time in the sound playback.

Seek(InTime: number)

Parameters

InTime (number) The time to seek to.

Example

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode")
SoundNodes[1]:Seek(5000) -- Seek to 5 seconds

▸ PlayDuration(InDuration)

Play the sound for a specified duration.

PlayDuration(InDuration: number)

Parameters

InDuration (number) The duration to play the sound.

Example

local SoundNodes = SimLabUtils:FindNodesByAttribute("SoundNode")
SoundNodes[1]:PlayDuration(10000) -- Play for 10 seconds

ASimLabController

Represents a Player Controller (The object that's used to control the player's character) in Lua.

new ASimLabController()

Instance Members

▸ GetCameraTransform()

Get the camera's transform.

GetCameraTransform(): FTransform

Returns

FTransform: The camera's transform.

Example

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;

▸ GetAttributeValue(AttributeName)

Get the attribute value with the given attribute name.

GetAttributeValue(AttributeName: string): string

Parameters

AttributeName (string) The name of the attribute to retrieve.

Returns

string: The attribute value.

Example

local Controller = SimLabUtils:GetFirstPlayerController()
local AttributeValue = Controller:GetAttributeValue("Name")

▸ PointToNode(InNewNode)

Point the controller to a specified object node.

PointToNode(InNewNode: ASimLabTransformNode)

Parameters

InNewNode (ASimLabTransformNode) The object node to point to.

Example

local Controller = SimLabUtils:GetFirstPlayerController()
local Nodes = SimLabUtils:FindNodesByAttribute("Name")
Controller:PointToNode(Nodes[1])

▸ RemovePointToNode()

Remove the pointed object association from the controller.

RemovePointToNode()

Example

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

▸ TeleportToView(InEyePosition, View)

Teleport the controller to a specified view position and orientation.

TeleportToView(InEyePosition: FVector, View: FRotator)

Parameters

InEyePosition (FVector) The eye position to teleport to.

View (FRotator) The rotation of the view.

Example

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

▸ TeleportToLocation(InEyePosition)

Teleport the controller to a specified location.

TeleportToLocation(InEyePosition: FVector)

Parameters

InEyePosition (FVector) The eye position to teleport to.

Example

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

USimLabLuaHttpRequest

Represents a Lua HTTP Request in Lua.

new USimLabLuaHttpRequest()

Instance Members

▸ SetRequestBody(JsonBody)

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

SetRequestBody(JsonBody: USimLabLuaJsonObject)

Parameters

JsonBody (USimLabLuaJsonObject) The JSON object to set as the request body.

Example

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

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

▸ ProcessRequest()

Process the HTTP request. Parameters allowed:

GET
POST
DELETE
PUT
REQUEST
PATCH

ProcessRequest()

Example

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

▸ AddHeader(FieldName, StringValue)

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.

AddHeader(FieldName: string, StringValue: string)

Parameters

FieldName (string) The name of the header field.

StringValue (string) The value of the header field.

Example

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

▸ SetEndpoint(InEndpoint)

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

SetEndpoint(InEndpoint: string)

Parameters

InEndpoint (string) The endpoint URL for the request.

Example

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

▸ SetVerb(InRequestVerb)

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

SetVerb(InRequestVerb: string)

Parameters

InRequestVerb (string) The HTTP verb for the request.

Example

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

▸ GetResponse()

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.

GetResponse(): USimLabLuaJsonObject

Returns

USimLabLuaJsonObject: The JSON response object.

Example

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

Events

▸ FOnLuaHttpRequestResponse

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.

FOnLuaHttpRequestResponse

Properties

HttpRequest (USimLabLuaHttpRequest) : The HTTP request that triggered the response.

Example

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)

USimLabLuaJsonObject

Represents a JSON Object in Lua.

new USimLabLuaJsonObject()

Instance Members

▸ SetStringField(FieldName, Value)

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

SetStringField(FieldName: string, Value: string)

Parameters

FieldName (string) The name of the field.

Value (string) The string value to set.

Example

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

▸ SetNumberField(FieldName, Value)

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

SetNumberField(FieldName: string, Value: number)

Parameters

FieldName (string) The name of the field.

Value (number) The number value to set.

Example

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

▸ SetBoolField(FieldName, Value)

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

SetBoolField(FieldName: string, Value: boolean)

Parameters

FieldName (string) The name of the field.

Value (boolean) The boolean value to set.

Example

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

▸ SetObjectField(FieldName, Value)

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.

SetObjectField(FieldName: string, Value: USimLabLuaJsonObject)

Parameters

FieldName (string) The name of the field.

Value (USimLabLuaJsonObject) The object value to set.

Example

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

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

▸ SetArrayField(FieldName, Value)

Set an array field in the JSON object.

SetArrayField(FieldName: string, Value: Array<USimLabLuaJsonValue>)

Parameters

FieldName (string) The name of the field.

Value (Array<USimLabLuaJsonValue>) The array value to set.

Example

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

JsonArray = {OutJSONArray1, OutJSONArray1}

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

▸ GetStringField(FieldName)

Get a string field from the JSON object.

GetStringField(FieldName: string): string

Parameters

FieldName (string) The name of the field.

Returns

string: The string value of the field.

Example

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

username = JSON_Object:GetStringField("username")

▸ GetNumberField(FieldName)

Get a number field from the JSON object.

GetNumberField(FieldName: string): number

Parameters

FieldName (string) The name of the field.

Returns

number: The number value of the field.

Example

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

age = JSON_Object:GetNumberField("age")

▸ GetBoolField(FieldName)

Get a boolean field from the JSON object.

GetBoolField(FieldName: string): boolean

Parameters

FieldName (string) The name of the field.

Returns

boolean: The boolean value of the field.

Example

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

IsInStock = JSON_Object:GetNumberField("instock")

▸ GetObjectField(FieldName)

Get a JSON Object field from the JSON object.

GetObjectField(FieldName: string): USimLabLuaJsonObject

Parameters

FieldName (string) The name of the field.

Returns

USimLabLuaJsonObject: The object value of the field.

Example

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

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

UsernamesSet = JSON_Object:GetObjectField("Usernames")

▸ GetArrayField(FieldName)

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

GetArrayField(FieldName: string): Array<USimLabLuaJsonValue>

Parameters

FieldName (string) The name of the field.

Returns

Array<USimLabLuaJsonValue>: The array value of the field.

Example

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

▸ ToString()

Returns a string containing the whole JSON object body.

ToString(): string

Returns

string: The JSON object as a string.

Example

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

JsonString = JSON_Object:ToString()

USimLabLuaJsonValue

Represents a Lua JSON Value in Lua.

new USimLabLuaJsonValue()

Instance Members

▸ AsNumber()

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

AsNumber(): number

Returns

number: The value as a floating-point number.

Example

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

▸ AsString()

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

AsString(): string

Returns

string: The value as a string.

Example

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

▸ AsBool()

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

AsBool(): boolean

Returns

boolean: The value as a boolean.

Example

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

▸ AsArray()

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

AsArray(): Array<USimLabLuaJsonValue>

Returns

Array<USimLabLuaJsonValue>: The value as an array of JSON values.

Example

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

▸ AsObject()

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

AsObject(): USimLabLuaJsonObject

Returns

USimLabLuaJsonObject: The value as a JSON object.

Throws

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

Example

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

▸ SetString(InValue)

Set this value as a string.

SetString(InValue: string)

Parameters

InValue (string) The string value to set.

Example

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

▸ SetNumber(InValue)

Set this value as a number.

SetNumber(InValue: number)

Parameters

InValue (number) The number value to set.

Example

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

▸ SetBool(InValue)

Set this value as a boolean.

SetBool(InValue: boolean)

Parameters

InValue (boolean) The boolean value to set.

Example

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

▸ SetArray(InValue)

Set this value as an array of JSON values.

SetArray(InValue: Array<USimLabLuaJsonValue>)

Parameters

InValue (Array<USimLabLuaJsonValue>) The array of JSON values to set.

Example

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)

▸ SetObject(InValue)

Set this value as a JSON object.

SetObject(InValue: USimLabLuaJsonObject)

Parameters

InValue (USimLabLuaJsonObject) The JSON object to set.

Example

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)

ASimLabMaterial

Represents a Material in SimLab VR Viewer.

new ASimLabMaterial()

Instance Members

▸ GetMaterialName()

Get the name of the material.

GetMaterialName(): string

Returns

string: The name of the material.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()

print(BoxMaterial:GetMaterialName())

▸ GetMaterialType()

Get the type of the material.

GetMaterialType(): string

Returns

string: The type of the material.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()

print(BoxMaterial:GetMaterialType())

▸ SetMaterialColor(NewColor)

Set the color of the material.

SetMaterialColor(NewColor: FLinearColor)

Parameters

NewColor (FLinearColor) The new color to set.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()

BoxMaterial:SetMaterialColor(UE.FLinearColor(1, 0, 0))

▸ GetMaterialColor()

Get the color of the material.

GetMaterialColor(): FLinearColor

Returns

FLinearColor: The color of the material.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()

local Color = BoxMaterial:GetMaterialColor()
local Alpha = BoxMaterial:GetMaterialAlpha()
Color.R = math.random()
Color.B = math.random()

print(tostring(Color))
print(Alpha)
BoxMaterial:SetMaterialColor(Color)

▸ SetMaterialAlpha(Value)

Set the alpha (transparency) of the material.

SetMaterialAlpha(Value: number)

Parameters

Value (number) The alpha value to set.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()
BoxMaterial:SetMaterialAlpha(0.5)

▸ GetMaterialAlpha()

Get the alpha (transparency) of the material.

GetMaterialAlpha(): number

Returns

number: The alpha value of the material.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()

local Alpha = BoxMaterial:GetMaterialAlpha()
print(Alpha)

ASimLabSceneState

Represents a Scene State in SimLab VR Viewer.

new ASimLabSceneState()

Extends ASimLabAnimationSequence

Instance Members

▸ SetDensity(Density)

Set Density of Physical Material Data in Material.

SetDensity(Density: number)

Parameters

Density (number) The density value to set.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()
BoxMaterial:SetDensity(0.5)

▸ GetDensity()

Get Density of Physical Material Data in Material.

GetDensity(): number

Returns

number: The density value of the material.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]

local BoxMaterial = Box:GetMaterial()

local Density = BoxMaterial:GetDensity()
print(Density)

▸ SetFriction(Friction)

Set the friction of the material.

SetFriction(Friction: number)

Parameters

Friction (number) The friction value to set.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]
local BoxMaterial = Box:GetMaterial()
BoxMaterial:SetFriction(0.5)

▸ GetFriction()

Get the friction of the material.

GetFriction(): number

Returns

number: The friction value of the material.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]
local BoxMaterial = Box:GetMaterial()

local Friction = BoxMaterial:GetFriction()
print(Friction)

▸ SetRestitution(Restitution)

Set the restitution (bounce) of the material.

SetRestitution(Restitution: number)

Parameters

Restitution (number) The restitution value to set.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]local BoxMaterial = Box:GetMaterial()
BoxMaterial:SetRestitution(0.5)

▸ GetRestitution()

Get the restitution (bounce) of the material.

GetRestitution(): number

Returns

number: The restitution value of the material.

Example

local Nodes1 = SimLabUtils:FindNodesByName("3DBox")
local Box = Nodes1[1]local BoxMaterial = Box:GetMaterial()

local Restitution = BoxMaterial:GetRestitution()
print(Restitution)

▸ GetSceneStateName()

Get the name of the scene state.

GetSceneStateName(): string

Returns

string: The name of the scene state.

Example

local SceneStates = SimLabUtils:FindSceneStatesByName("Mid")
local SceneState = SceneStates[1]

print(SceneState:GetSceneStateName())

▸ Apply()

Apply the scene state.

Apply()

Example

local SceneStates = SimLabUtils:FindSceneStatesByName("Mid")
local SceneState = SceneStates[1]

SceneState:Apply()

ASimLabQuizNode

Represents a Quiz in SimLab VR Viewer.

new ASimLabQuizNode()

Instance Members

▸ ActivateQuiz()

Activate the quiz associated with this node.

ActivateQuiz()

Example

local Nodes1 = SimLabUtils:FindNodesByName("QuizButton")
Nodes1[1]:ActivateQuiz()

ASimLabAnimationSequence

Represents an Animation Sequence in SimLab VR Viewer.

new ASimLabAnimationSequence()

Instance Members

▸ GetSequenceName()

Get the name of the animation sequence.

GetSequenceName(): string

Returns

string: The name of the animation sequence.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

print(Sequence:GetSequenceName())

▸ SetIsLooping(bLoop)

Set whether the animation sequence is looping.

SetIsLooping(bLoop: boolean)

Parameters

bLoop (boolean) Whether the animation should loop.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:SetIsLooping(true)

▸ IsLooping()

Check if the animation sequence is looping.

IsLooping(): boolean

Returns

boolean: Whether the animation is looping.

▸ SetIsSwinging(bSwing)

Set whether the animation sequence is swinging.

SetIsSwinging(bSwing: boolean)

Parameters

bSwing (boolean) Whether the animation should swing.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:SetIsSwinging(true)

▸ IsSwinging()

Check if the animation sequence is swinging.

IsSwinging(): boolean

Returns

boolean: Whether the animation is swinging.

▸ SetPlayRate(NewRate)

Set the play rate of the animation sequence.

SetPlayRate(NewRate: number)

Parameters

NewRate (number) The new play rate.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:SetPlayRate(0.5)

▸ GetPlayRate()

Get the play rate of the animation sequence.

GetPlayRate(): number

Returns

number: The play rate of the animation.

▸ GetFullRangeStartFrame()

Get the start frame of the full animation range.

GetFullRangeStartFrame(): number

Returns

number: The start frame of the full animation range.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:SetPlayRange(Sequence:GetFullRangeStartFrame(), Sequence:GetFullRangeEndFrame())
print(Sequence:GetFullRangeStartFrame())

▸ GetFullRangeEndFrame()

Get the end frame of the full animation range.

GetFullRangeEndFrame(): number

Returns

number: The end frame of the full animation range.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:SetPlayRange(Sequence:GetFullRangeStartFrame(), Sequence:GetFullRangeEndFrame())
print(Sequence:GetFullRangeEndFrame())

▸ SetPlayRange(StartFrame, EndFrame)

Set the play range of the animation sequence.

SetPlayRange(StartFrame: number, EndFrame: number)

Parameters

StartFrame (number) The start frame of the play range.

EndFrame (number) The end frame of the play range.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:SetPlayRange(Sequence:GetFullRangeStartFrame(), Sequence:GetFullRangeEndFrame())

▸ GetPlayRangeStartFrame()

Get the start frame of the play range.

GetPlayRangeStartFrame(): number

Returns

number: The start frame of the play range.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

print(Sequence:GetPlayRangeStartFrame())

▸ GetPlayRangeEndFrame()

Get the end frame of the play range.

GetPlayRangeEndFrame(): number

Returns

number: The end frame of the play range.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

print(Sequence:GetPlayRangeEndFrame())

▸ PlayFromStart()

Start playing the animation from the beginning.

PlayFromStart()

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

if Sequence:IsPlaying() then
  Sequence:Stop()
else
  Sequence:PlayFromStart()
end

▸ Play()

Start playing the animation from the current frame.

Play()

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:Play()

▸ Continue()

Continue playing the animation from the current frame.

Continue()

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:Continue()

▸ Reverse()

Reverse the animation from the current frame.

Reverse()

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:Reverse()

▸ ReverseFromEnd()

Reverse the animation from the end frame.

ReverseFromEnd()

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:ReverseFromEnd()

▸ Flip()

Flip the direction of the animation from the current frame.

Flip()

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:Flip()

▸ Stop()

Stop playing the animation.

Stop()

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequence:Stop()

▸ Seek(Frame)

Seek to a specific frame in the animation.

Seek(Frame: number)

Parameters

Frame (number) The frame to seek to.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

Sequnce:Seek(54.555)

▸ IsPlaying()

Check if the animation is currently playing.

IsPlaying(): boolean

Returns

boolean: Whether the animation is playing.

Example

local Sequences = SimLabUtils:FindSequencesByName("Sequence_1")
local Sequence = Sequences[1]

if Sequence:IsPlaying() then
  Sequence:Stop()
else
  Sequence:PlayFromStart()
end

▸ IsReversing()

Check if the animation is currently reversing.

IsReversing(): boolean

Returns

boolean: Whether the animation is reversing.

ASimLabTransformNode

Represents a Scene Node in SimLab VR Viewer.

new ASimLabTransformNode()

Instance Members

▸ GetParentNode()

Get the parent node of this transform node.

GetParentNode(): ASimLabTransformNode

Returns

ASimLabTransformNode: The parent node.

▸ GetInitialParentNode()

Get the initial parent node of this transform node.

GetInitialParentNode(): ASimLabTransformNode

Returns

ASimLabTransformNode: The initial parent node.

▸ SetParentNode(InParent, InAttachRules)

Set the parent node of this transform node.

SetParentNode(InParent: ASimLabTransformNode, InAttachRules: string)

Parameters

InParent (ASimLabTransformNode) The new parent node.

InAttachRules

(string
            = "")

Attachment rules (optional).

▸ ResetToInitialParentNode(InAttachRules)

Reset this node to its initial parent node.

ResetToInitialParentNode(InAttachRules: string)

Parameters

InAttachRules

(string
            = "")

Attachment rules (optional).

▸ GetChildrenNodes()

Get a set of children nodes of this transform node.

GetChildrenNodes(): Set<ASimLabTransformNode>

Returns

Set<ASimLabTransformNode>: A set of children nodes.

Example

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

▸ GetAncestorNodes(bIncludingMe)

Get an array of ancestor nodes of this transform node.

GetAncestorNodes(bIncludingMe: boolean): Array<ASimLabTransformNode>

Parameters

bIncludingMe

(boolean
            = false)

Include this node in the result (optional).

Returns

Array<ASimLabTransformNode>: An array of ancestor nodes.

▸ GetNodeName()

Get the name of this transform node.

GetNodeName(): string

Returns

string: The name of the node.

Example

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

print(Box:GetNodeName())

▸ GetNodeAttribute(InName)

Get an attribute of this transform node by name.

GetNodeAttribute(InName: string): string

Parameters

InName (string) The name of the attribute.

Returns

string: The value of the attribute.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Box" then 
        Box = Node
    end
end

▸ GetNodeAttributeFromCategory(InName, InCategory)

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

GetNodeAttributeFromCategory(InName: string, InCategory: string): string

Parameters

InName (string) The name of the attribute.

InCategory (string) The category of the attribute.

Returns

string: The value of the attribute.

▸ SetNodeAttribute(InName, InValue)

Set an attribute of this transform node by name.

SetNodeAttribute(InName: string, InValue: string)

Parameters

InName (string) The name of the attribute.

InValue (string) The value to set.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Box

for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Box" then 
        Box = Node
    end
end

local BoxCopy = Box:CloneNode()
BoxCopy:SetNodeAttribute("Name", "Copy")

▸ SetNodeAttributeInCategory(InName, InValue, InCategory)

Set an attribute in a specific category of this transform node by name.

SetNodeAttributeInCategory(InName: string, InValue: string, InCategory: string)

Parameters

InName (string) The name of the attribute.

InValue (string) The value to set.

InCategory (string) The category of the attribute.

▸ NodeHasAttribute(InName)

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

NodeHasAttribute(InName: string): boolean

Parameters

InName (string) The name of the attribute.

Returns

boolean: Whether the node has the attribute.

▸ NodeHasAttributeInCategory(InName, InCategory)

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

NodeHasAttributeInCategory(InName: string, InCategory: string): boolean

Parameters

InName (string) The name of the attribute.

InCategory (string) The category of the attribute.

Returns

boolean: Whether the node has the attribute in the category.

▸ SetNodeGlowState(bIsGlow)

Set the glow state of this node.

SetNodeGlowState(bIsGlow: boolean)

Parameters

bIsGlow (boolean) Whether to set the node as glowing.

▸ GlowNode()

Make this node glow.

GlowNode()

Example

-- Highlight first airplane
FirstAirPlane = SimLabUtils:GetObjectsByAttribute("AirPlane")[1]
FirstAirPlane:GlowNode()

▸ StopGlowNode()

Stop glowing this node.

StopGlowNode()

Example

-- Stop Highlight first airplane
FirstAirPlane = SimLabUtils:GetObjectsByAttribute("AirPlane")[1]
FirstAirPlane:StopGlowNode()

▸ IsNodeGlowing()

Check if this node is currently glowing.

IsNodeGlowing(): boolean

Returns

boolean: Whether the node is glowing.

▸ SetNodeVisibility(bInVisible)

Set the visibility state of this node.

SetNodeVisibility(bInVisible: boolean)

Parameters

bInVisible (boolean) Whether to set the node as visible.

Example

-- Hide first airplane
FirstAirPlane = SimLabUtils:GetObjectsByAttribute("AirPlane")[1]
FirstAirPlane:SetNodeVisibility(false)

▸ IsNodeVisible()

Check if this node is currently visible.

IsNodeVisible(): boolean

Returns

boolean: Whether the node is visible.

▸ ShowNode()

Show this node.

ShowNode()

▸ HideNode()

Hide this node.

HideNode()

▸ DeleteNode()

Delete this node.

DeleteNode()

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Copy
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Copy" then 
        Copy = Node
    end
end

Copy:DeleteNode()

▸ CloneNode()

Clone this node.

CloneNode(): ASimLabTransformNode

Returns

ASimLabTransformNode: The cloned node.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Box" then 
        Box = Node
    end
end

local BoxCopy = Box:CloneNode()

▸ GetNodeGlobalTransform()

Get the global transform of this node.

GetNodeGlobalTransform(): FTransform

Returns

FTransform: The global transform.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    end
end

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:GetNodeGlobalTransform()

▸ GetNodeLocalTransform()

Get the local transform of this node.

GetNodeLocalTransform(): FTransform

Returns

FTransform: The local transform.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    end
end

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()

▸ GetInitialGlobalTransform()

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

GetInitialGlobalTransform(): FTransform

Returns

FTransform: The initial global transform.

▸ SetNodeGlobalTransform(InTransform)

Set the global transform of this node.

SetNodeGlobalTransform(InTransform: FTransform)

Parameters

InTransform (FTransform) The new global transform.

▸ SetNodeLocalTransform(InTransform)

Set the relative transform of this node.

SetNodeLocalTransform(InTransform: FTransform)

Parameters

InTransform (FTransform) The new local transform.

▸ AnimatedSetNodeGlobalTransform(ToTransform, InPlayDurationSeconds)

Animate setting the global transform of this node.

AnimatedSetNodeGlobalTransform(ToTransform: FTransform, InPlayDurationSeconds: number)

Parameters

ToTransform (FTransform) The target global transform.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

▸ AnimatedSetNodeLocalTransform(ToTransform, InPlayDurationSeconds)

Animate setting the local transform of this node.

AnimatedSetNodeLocalTransform(ToTransform: FTransform, InPlayDurationSeconds: number)

Parameters

ToTransform (FTransform) The target local transform.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

▸ GetNodeGlobalLocation()

Get the global location of this node.

GetNodeGlobalLocation(): FVector

Returns

FVector: The global location.

▸ GetNodeLocalLocation()

Get the local location of this node.

GetNodeLocalLocation(): FVector

Returns

FVector: The local location.

▸ SetNodeGlobalLocation(InLocation)

Set the global location of this node.

SetNodeGlobalLocation(InLocation: FVector)

Parameters

InLocation (FVector) The new global location.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Box" then 
        Box = Node
    end
end

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

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

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

local BoxCopy = Box:CloneNode()

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

▸ SetNodeLocalLocation(InLocation)

Set the local location of this node.

SetNodeLocalLocation(InLocation: FVector)

Parameters

InLocation (FVector) The new local location.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
local Sphere
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    elseif AttriblueValue == "Sphere" then 
        Sphere = Node
    elseif AttriblueValue == "Box" then 
        Box = Node
    end
end

Box:MakeNodeGrabbable(true)
local children = Box:GetChildrenNodes()
for i,Node in ipairs(Nodes) 
do
    print(Node:GetNodeName())
end

Pyramid:SetNodeLocalLocation(UE.FVector(0.5))

▸ FallToSurface()

Make this node fall to the surface.

FallToSurface()

Example

-- Make first airplane fall to the surface
FirstAirPlane = SimLabUtils:GetObjectsByAttribute("AirPlane")[1]
FirstAirPlane:FallToSurface()

▸ AnimatedFallToSurface(InPlayDurationSeconds)

Animate making this node fall to the surface.

AnimatedFallToSurface(InPlayDurationSeconds: number)

Parameters

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

▸ AnimatedSetNodeGlobalLocation(InLocation, InPlayDurationSeconds)

Animate setting the global location of this node.

AnimatedSetNodeGlobalLocation(InLocation: FVector, InPlayDurationSeconds: number)

Parameters

InLocation (FVector) The target global location.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

▸ AnimatedSetNodeLocalLocation(InLocation, InPlayDurationSeconds)

Animate setting the local location of this node.

AnimatedSetNodeLocalLocation(InLocation: FVector, InPlayDurationSeconds: number)

Parameters

InLocation (FVector) The target local location.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
local Sphere
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    elseif AttriblueValue == "Sphere" then 
        Sphere = Node
    elseif AttriblueValue == "Box" then 
        Box = Node
    end
end

Box:MakeNodeGrabbable(true)
local children = Box:GetChildrenNodes()
for i,Node in ipairs(Nodes) 
do
    print(Node:GetNodeName())
end

Pyramid:AnimatedSetNodeLocalLocation(UE.FVector(0.5), 1)

▸ GetNodeGlobalRotation()

Get the global rotation of this node.

GetNodeGlobalRotation(): FRotator

Returns

FRotator: The global rotation.

▸ GetNodeLocalRotation()

Get the local rotation of this node.

GetNodeLocalRotation(): FRotator

Returns

FRotator: The local rotation.

▸ SetNodeGlobalRotation(InRotation)

Set the global rotation of this node.

SetNodeGlobalRotation(InRotation: FRotator)

Parameters

InRotation (FRotator) The new global rotation.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Box" then 
        Box = Node
    end
end

local Player = SimLabUtils:GetFirstPlayerController()
local CameraTransform = Player:GetCameraTransform()
local CameraRotation = CameraTransform.Rotation
local CameraLocation = CameraTransform.Translation
local ForwardVector = CameraRotation:GetForwardVector()
local NewLocation = CameraLocation + ForwardVector * -3;

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

▸ SetNodeLocalRotation(InRotation)

Set the local rotation of this node.

SetNodeLocalRotation(InRotation: FRotator)

Parameters

InRotation (FRotator) The new local rotation.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
local Sphere
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    elseif AttriblueValue == "Sphere" then 
        Sphere = Node
    elseif AttriblueValue == "Box" then 
        Box = Node
    end
end

Box:MakeNodeGrabbable(true)
local children = Box:GetChildrenNodes()
for i,Node in ipairs(Nodes) 
do
    print(Node:GetNodeName())
end

Pyramid:SetNodeLocalRotation(UE.FRotator(0, -90 , 0))

▸ ResetOrientation(InType)

Reset the orientation of this node.

ResetOrientation(InType: string)

Parameters

InType

(string
            = "")

The type of reset (optional).

Example

-- Reset first airplane orientation
FirstAirPlane = SimLabUtils:GetObjectsByAttribute("AirPlane")[1]
FirstAirPlane:ResetOrientation()

▸ AnimatedSetNodeGlobalRotation(InRotation, InPlayDurationSeconds, bInShortestPath)

Animate setting the global rotation of this node.

AnimatedSetNodeGlobalRotation(InRotation: FRotator, InPlayDurationSeconds: number, bInShortestPath: boolean)

Parameters

InRotation (FRotator) The target global rotation.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

bInShortestPath

(boolean
            = true)

Whether to take the shortest path (optional).

▸ AnimatedSetNodeLocalRotation(InRotation, InPlayDurationSeconds, bInShortestPath)

Animate setting the local rotation of this node.

AnimatedSetNodeLocalRotation(InRotation: FRotator, InPlayDurationSeconds: number, bInShortestPath: boolean)

Parameters

InRotation (FRotator) The target local rotation.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

bInShortestPath

(boolean
            = true)

Whether to take the shortest path (optional).

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
local Sphere
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    elseif AttriblueValue == "Sphere" then 
        Sphere = Node
    elseif AttriblueValue == "Box" then 
        Box = Node
    end
end

Box:MakeNodeGrabbable(true)
local children = Box:GetChildrenNodes()
for i,Node in ipairs(Nodes) 
do
    print(Node:GetNodeName())
end

Pyramid:AnimatedSetNodeLocalRotation(UE.FRotator(0, -90 , 0), 0.3)

▸ GetNodeGlobalScale()

Get the global scale of this node.

GetNodeGlobalScale(): FVector

Returns

FVector: The global scale.

▸ GetNodeLocalScale()

Get the local scale of this node.

GetNodeLocalScale(): FVector

Returns

FVector: The local scale.

▸ SetNodeGlobalScale(InScale)

Set the global scale of this node.

SetNodeGlobalScale(InScale: FVector)

Parameters

InScale (FVector) The new global scale.

▸ SetNodeLocalScale(InScale)

Set the local scale of this node.

SetNodeLocalScale(InScale: FVector)

Parameters

InScale (FVector) The new local scale.

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
local Sphere
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    elseif AttriblueValue == "Sphere" then 
        Sphere = Node
    elseif AttriblueValue == "Box" then 
        Box = Node
    end
end

Box:MakeNodeGrabbable(true)
local children = Box:GetChildrenNodes()
for i,Node in ipairs(Nodes) 
do
    print(Node:GetNodeName())
end

Pyramid:SetNodeLocalScale(UE.FVector(0.2))

▸ AnimatedSetNodeGlobalScale(InScale, InPlayDurationSeconds)

Animate setting the global scale of this node.

AnimatedSetNodeGlobalScale(InScale: FVector, InPlayDurationSeconds: number)

Parameters

InScale (FVector) The target global scale.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

▸ AnimatedSetNodeLocalScale(InScale, InPlayDurationSeconds)

Animate setting the local scale of this node.

AnimatedSetNodeLocalScale(InScale: FVector, InPlayDurationSeconds: number)

Parameters

InScale (FVector) The target local scale.

InPlayDurationSeconds

(number
            = 1.0)

The duration of the animation in seconds (optional).

Example

local Nodes = SimLabUtils:FindNodesByAttribute("Name")
local Pyramid
local Sphere
local Box
for i,Node in ipairs(Nodes) 
do 
    local AttriblueValue = Node:GetNodeAttribute("Name")
    if AttriblueValue == "Pyramid" then 
        Pyramid = Node
    elseif AttriblueValue == "Sphere" then 
        Sphere = Node
    elseif AttriblueValue == "Box" then 
        Box = Node
    end
end

Box:MakeNodeGrabbable(true)
local children = Box:GetChildrenNodes()
for i,Node in ipairs(Nodes) 
do
    print(Node:GetNodeName())
end

Pyramid:AnimatedSetNodeLocalScale(UE.FVector(0.2), 1)

▸ CancelNodeGrab()

Cancel grabbing this node.

CancelNodeGrab()

▸ MakeNodeGrabbable(bEnable)

Make this node grabbable or ungrabbable.

MakeNodeGrabbable(bEnable: boolean)

Parameters

bEnable

(boolean
            = true)

Whether to enable grabbing for this node (optional).

Example

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

Box:MakeNodeGrabbable(true)

▸ SetGrabbableSequence(InSequence)

Set the grabbable sequence for this node.

SetGrabbableSequence(InSequence: ASimLabAnimationSequence)

Parameters

InSequence (ASimLabAnimationSequence) The grabbable sequence to set (optional).

Example

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

Box:SetGrabbableSequence(Sequence)

▸ ShowMessageBox(Title, Body)

Show a message box on this node.

ShowMessageBox(Title: string, Body: string)

Parameters

Title (string) The title of the message box.

Body (string) The body of the message box.

▸ IsMessageBoxShown()

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

IsMessageBoxShown(): boolean

Returns

boolean: Whether a message box is shown.

▸ HideMessageBox()

Hide the message box on this node.

HideMessageBox()

▸ SetNodeSimulatePhysics(bInSimulate)

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

SetNodeSimulatePhysics(bInSimulate: boolean)

Parameters

bInSimulate (boolean) Whether to enable simulate physics for this node.

Example

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

Box:SetNodeSimulatePhysics(true)

▸ IsNodeSimulatingPhysics()

Check if simulate physics is enabled for this node.

IsNodeSimulatingPhysics(): boolean

Returns

boolean: Whether simulate physics is enabled.

Example

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

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

▸ AlignNodeTo(OtherNode)

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

AlignNodeTo(OtherNode: ASimLabTransformNode)

Parameters

OtherNode (ASimLabTransformNode) The target node to align to.

Example

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

Box:AlignNodeTo(BoxCopy)

UEventsVariable

Represents an Events Variable in SimLab VR Viewer.

new UEventsVariable()

Instance Members

▸ Name

The name of the variable.

Name

Type: string

▸ TypeName

The type name of the variable.

TypeName

Type: string

▸ ValueFromString(InStringValue)

Set the variable's value from a string.

ValueFromString(InStringValue: string)

Parameters

InStringValue (string) The string value to set.

▸ ValueToString()

Get the variable's value as a string.

ValueToString(): string

Returns

string: The variable's value as a string.

Example

local MyNumber = 1
local Var = MyNumber:ValueToString()

▸ ChangeVariableValue(NewExpression)

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

ChangeVariableValue(NewExpression: string)

Parameters

NewExpression (string) The Lua expression to change the variable's value.

▸ SetStringValue(NewValue)

Set the variable's value to a string.

SetStringValue(NewValue: string)

Parameters

NewValue (string) The new string value to set.

▸ SetNumberValue(NewValue)

Set the variable's value to a float.

SetNumberValue(NewValue: number)

Parameters

NewValue (number) The new float value to set.

▸ SetNumberValue(NewValue)

Set the variable's value to a double.

SetNumberValue(NewValue: number)

Parameters

NewValue (number) The new double value to set.

▸ SetIntegerValue(NewValue)

Set the variable's value to an integer.

SetIntegerValue(NewValue: number)

Parameters

NewValue (number) The new integer value to set.

▸ UpdateTimeValue()

Set the variable's value to the current time.

UpdateTimeValue()

ASimLabVideoMaterial

Represents a Video Material in SimLab VR Viewer.

new ASimLabVideoMaterial()

Instance Members

▸ ToggleState()

Toggle the playback state of the video.

ToggleState()

▸ Play()

Start playing the video.

Play()

▸ Stop()

Stop the video playback.

Stop()

▸ Seek(InTime)

Seek to a specific time in the video playback.

Seek(InTime: number)

Parameters

InTime (number) The time to seek to.

▸ PlayDuration(InDuration)

Play the video for a specified duration.

PlayDuration(InDuration: number)

Parameters

InDuration (number) The duration to play the video.

ASimLabVRCamera

Represents a VR Camera in SimLab VR Viewer.

new ASimLabVRCamera()

Instance Members

▸ IsApplyOrientation()

Check if orientation is applied when teleporting to the camera.

IsApplyOrientation(): boolean

Returns

boolean: Whether orientation is applied when teleporting.

▸ GetTeleportLocation()

Get the teleport location of the camera.

GetTeleportLocation(): FVector

Returns

FVector: The teleport location.

▸ GetTeleportRotation()

Get the teleport rotation of the camera.

GetTeleportRotation(): FRotator

Returns

FRotator: The teleport rotation.

Lua Scripting for SimLab Training Builder

For Advanced Users

A Proper License

The ‘Run Script’ Node

The print Function

Key Syntax Rules in Lua Programming

Caution: Lua Scripting and SimLab VR Viewer Stability

Lua Scripting Tutorials: From Beginner to Beyond

Links to Relative External Resources:

USimLabLuaManager

ASimLab3DObjectNode

ASimLab3DSoundNode

ASimLabController

USimLabLuaHttpRequest

USimLabLuaJsonObject

USimLabLuaJsonValue

ASimLabMaterial

ASimLabSceneState

ASimLabQuizNode

ASimLabAnimationSequence

ASimLabTransformNode

UEventsVariable

ASimLabVideoMaterial

ASimLabVRCamera

The `print` Function