Layout Link Particle Object

Layout Link Particle

Description

This Level Object is used to play Particle Objects. Any changes made to the Particle Layout associated with the Layout Link Particle are automatically updated in every Layout in which it is used.

Location

Right-click on an empty space in the Layout Scene Manager and choose Building Blocks > Layout Link Particle 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 Particle can be aliased.
ENABLED	bool	Set the Layout Link Particle enabled or not.
NO ROOMPIECE COLLISION	bool	Room Pieces within the Layout Link will not have collision.
SAVES	bool	If True the Layout Link Particle will save its current state with the level.
START ON LOAD	bool	If True the set Particle will start playing on level load.
VISIBLE	bool	Set the Layout Link Particle 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 Particle to be visible.

Hide

Set the Layout Link Particle to be invisible.

Enable

Enable the Layout Link Particle object.

Disable

Disable the Layout Link Particle object.

Enable and Show

Enable the Layout Link Particle and set it to be visible.

Disable and Hide

Disable the Layout Link Particle and set it to be invisible.

Collidable

Set the Layout Link Particle object to be collidable.

Not Collidable

Set the Layout Link Particle object to not be collidable.

Start Particle

Start playing the set Particle Object.

Stop Particle

Stop playing the set Particle Object.

Force Stop Particle

Force stop playing the set Particle Object. This will immediately stop and remove the Particle.

Output Events

On Visible

This event will fire when the Layout Link Particle receives a "Show" Input event.

On Invisible

This event will fire when the Layout Link Particle receives a "Hide" Input event.

Enabled

This event will fire when the Layout Link Particle receives an "Enable" Input event.

Disabled

This event will fire when the Layout Link Particle receives a "Disable" Input event.

Particle Started

This event will fire when the Layout Link Particle receives a "Start Particle" Input event.

• This event will also fire if the "Start on Load" property is True.

Particle Stopped

This event will fire when the Layout Link Particle receives a "Stop Particle" or "Force Stop Particle" Input event.