Layout Link Controller Object

From Runic Games Wiki
Jump to: navigation, search

Contents

Layout Link Controller

Description

This Level Object is used to contain one or more Level Objects, but treat them as a single object. It differs from a Layout Link in that the Level Objects inside of it can be moved around while still maintaining all the benefits of a standard Layout Link Object. It can also be used to control a Timeline inside the associated Layout. The Timeline in the Layout must have the "Layout Control" property set to True. Any changes made to the Layout associated with the Layout Link Controller are automatically updated in every Layout in which it is used. The one caveat is any positional changes made to Level Objects in the Layout associated with the Layout Link Controller will be ignored in every Layout in which those same Level Objects have been moved using the Layout Link Controller.

Location

Right-click on an empty space in the Layout Scene Manager and choose Building Blocks > Layout Link Controller from the list.

Properties

Name Type Description Read Only
ORIENTATION
FORWARD
CVector3
Forward by X,Y,Z.
RIGHT
CVector3
Right by X,Y,Z.
UP
CVector3
Up by X,Y,Z.
YAW
float
Yaw Rotation.
POSITION
POSITION
CVector3
Position by X,Y,Z world coordinates.
PROPERTIES
CAN ALIAS
bool
Controls whether or not the Layout Link Controller can be aliased.
DURATION MODIFY
float
Changes the duration of a Timeline if the Timeline is set to allow it.
ENABLED
bool
Set the Layout Link Controller enabled or not.
FORCE START
bool
Forces the Layout Link Controller to start playing on load.
NO ROOMPIECE COLLISION
bool
Room Pieces within the Layout Link Controller will not have collision.
VISIBLE
bool
Set the Layout Link Controller visible or not.
RESOURCES
LAYOUT FILE
string
The Layout file to load.
SCALE
SCALE
float
Scale the Layout Link Controller uniformly on the X, Y, Z axes (if set to be Scalable).
X
float
Scale the Layout Link Controller on the X axis (if set to be Scalable).
Y
float
Scale the Layout Link Controller on the Y axis (if set to be Scalable).
Z
float
Scale the Layout Link Controller on the Z axis (if set to be Scalable).

Input Events

Show
Set the Layout Link Controller to be visible.
Hide
Set the Layout Link Controller to be invisible.
Enable
Enable the Layout Link Controller object.
Disable
Disable the Layout Link Controller object.
Enable and Show
Enable the Layout Link Controller and set it to be visible.
Disable and Hide
Disable the Layout Link Controller and set it to be invisible.
Collidable
Set the Layout Link Controller object to be collidable.
Not Collidable
Set the Layout Link Controller object to not be collidable.
Play
Play the Timeline inside the associated Layout forwards.
Play Backwards
Play the Timeline inside the associated Layout backwards.
Stop
Stop the Timeline inside the associated Layout.
Pause
Pause the Timeline inside the associated Layout.
Reset
Reset the Timeline inside the associated Layout to the beginning.
Reset To End
Reset the Timeline inside the associated Layout to the end.

Output Events

On Visible
This event will fire when the Layout Link Controller receives a "Show" Input event.
On Invisible
This event will fire when the Layout Link Controller receives a "Hide" Input event.
Enabled
This event will fire when the Layout Link Controller receives an "Enable" Input event.
Disabled
This event will fire when the Layout Link Controller receives a "Disable" Input event.
Started
This event will fire when the Layout Link Controller receives a "Play" or "Play Forwards" Input event.
  • This event will also fire if "Force Start" is set to True.
Started Forwards
This event will fire when the Layout Link Controller receives a "Play" or "Play Forwards" Input event.
  • This event will also fire if "Force Start" is set to True.
Started Backwards
This event will fire when the Layout Link Controller receives a "Play Backwards" Input event.
Stopped
This event will fire when the Layout Link Controller finishes playing or receives a "Stop" Input event.
Stopped Forwards
This event will fire when the Layout Link Controller finishes playing forwards or receives a "Stop" Input event while playing forwards.
Stopped Backwards
This event will fire when the Layout Link Controller finishes playing backwards or receives a "Stop" Input event while playing backwards.
Looped
This event will fire when the Timeline inside the associated Layout loops.
Paused
This event will fire when the Layout Link Controller receives a "Pause" Input event.
Reset to Beginning
This event will fire when the Layout Link Controller receives a "Reset" Input event.
Reset to End
This event will fire when the Layout Link Controller receives a "Reset to End" Input event.
Personal tools
Namespaces

Variants
Actions
Navigation
Runic Sites
Toolbox