Skip to main content
Version: Next

Events

When you extend the use of SkyReal with Blueprints you quickly need to trigger actions with events such as controllers inputs, user actions, user position, ...

This events are necessary to trigger actions like displaying messages, starting animations, changing materials, ...

Here is a list of common events:

Standard events

EventDescription
all_v1.11_skyreal_experience-customization_event-beginplayEvent triggered once at the very beginning of the experience.
all_v1.11_skyreal_experience-customization_event-tickEvent triggered all the time, at every tick. The interval between two ticks is the Delta Seconds variable.

Controllers inputs

This events exists for both hands.

EventDescription
event pie menuPie menu button pressed.
event gripGrip button pressed (button inside the controller, under the middle finger).
event selectSelection button pressed.
AxisRightController_XJoystick moved on X axis (transversal). You get a value between 0 and 1.
AxisRightController_YJoystick moved on Y axis (forward). You get a value between 0 and 1.

You can also use keyboard inputs. Type the input letter to find the event.

Parts interactions

You can add specific events for every parts you can access from your blueprint (using variables of type Skr Part). These events are accessible in the Details tab of the variable.

all_v1.11_skyreal_experience-customization_actor-events

The most useful events are:

EventDescription
all_v1.11_skyreal_experience-customization_event-begin-overlapEvent triggered when another actor begins to overlap. Can be used to determine user position.
all_v1.11_skyreal_experience-customization_event-clickedEvent triggered when the actor is clicked with a mouse.
WARNING: It doesn't work with lasers

Custom events

You can bind actions to specific events using a custom event.

custom event binding

Unreal events

EventDescription
bind to on clickedYour custom event is executed any time the part connected to the target pin is clicked.
bind to on controller ready to useYour custom event is executed any time the part connected to the target pin overlaps with another part.

SkyReal events

EventDescription
bind event to on is in VR status changedYour custom event is executed any time you enter or quit VR in SkyReal.
bind event to on feature is snappedYour custom event is executed any time a part is snapped to its feature in SkyReal.
bind to on controller ready to useYour custom event is executed when the skr controller is ready to use. It is necessary to use the skr framework controller. see SDK page for further information.
bind event to is world changedYour custom event is executed any time a user swaps between Visible/Hidden/Trash worlds.