Version: v1.13

SDK

The SDK is the list of SkyReal functions opened to blueprints. Some events also come with the SDK, you will find them in the custom events section.

To use these functions you need to pass them the Framework Connector as a parameter.

get connector

Get the Framework Connector#

You just need to get the Framework Connector once. If you use multiple functions from the SDK, a good practice is to store the Connector into a variable at the initialization of the map.

You can use this blueprint to wait until the connexion to SkyReal is established and store the controller in a variable (the variable must be of type Skr Framework Connector Object Reference).

store connector

SDK functions#

To find the functions you need to be in the context of the Framework Connector. To do so, click and drag the blue pin of the Connector. You will find the SDK in the Skr category.

sdk functions

2D#

FunctionDescription
Change 2D Interface visibilityHide the desktop interface: can be useful to create your own GUI.
Is in 2DReturns a boolean: true if you are not in VR.
Switch to 2DForce quit VR.

Animation#

You can call all the animation commands available in SkyReal.

FunctionDescription
Get All Animations
Get Animation Duration in Seconds
Pause (All) Animation(s)
Play (All) Animation(s)
Reset (All) Animation(s)
Set Animation Time
Start/Stop Record Animation
Register/Unregister Unreal AnimationAdd/Remove a Level Sequence animation in SkyReal.

Bracelet#

You can create your own bracelet widget to execute your custom commands.

FunctionDescription
Clean Widget Class in BraceletUnload the existing widget from the bracelet.
Send Widget Class in BraceletAdd your custom widget to the bracelet (only one slot is available).

Command#

FunctionDescription
Execute Command from Name
Force Exit Current Command
Get All Commands
Is Executing Command

Environment#

FunctionDescription
Add EnvironmentAdd a SkrEnvironment to the SkyReal environments list.
Get Current Environment
Load Environment from ClassLoad an environment at runtime passing the object.
Load Environment from NameLoad an environment at runtime passing the name.

Navigation#

FunctionDescription
Change Navigation ModeSwitch between the three VR navigation modes.
Enable NavigationChoose to allow or block user navigation.
Get All Navigation ModesList navigation modes.
Get Current Navigation Mode

Notification#

FunctionDescription
Send Message NotificationSend a notification that will be displayed in all the notification panels.

Screenshot#

FunctionDescription
Auto Take Screen ShotTake a Full HD screenshot in SkyReal.
Auto Take Screen Shot with SizeTake a screenshot with custom size.

Selection#

FunctionDescription
Get Current Selection
Set Current Selection

Tool#

FunctionDescription
Add ToolAdd a SkrTool to the SkyReal tools list

User#

FunctionDescription
Get Current VRInterfacesGet the current Pie Menu profile.
Get Local UserReturn the pawn.
Get User Controller Actor
Get User Effector TransformReturn the transform of the origin of the lasers.
Get User Head Actor
Get VRInterfaces Custom
Get VRInterfaces Preset
Load VRInterfacesChange the Pie Menu configuration.

Video#

FunctionDescription
Get Videos PathString: Get the path toward the video folder.

Views#

FunctionDescription
Fit ObjectsReframe on the selection.
Get All Skr Views
Navigate to View

VR#

FunctionDescription
Get Controller Hit TestReturn the first part that overlap with controllers
Get Controller Hit TestsReturn the list of parts that overlap with controllers
Get VR Device NameReturn the name of the HMD.
Is in VRBoolean: true if you are in VR.
Switch to VR