Group Object

Group

Description

This Level Object is used to organize the Layout Scene Manager and easily modify all objects in the Group. It can be used to load objects based on Level Feature Tags, Themes, Game Mode, or random roll.

Location

Right-click on an empty space in the Layout Scene Manager and choose Group from the list.

Properties

Name	Type	Description	Read Only
CHILD RANDOMIZATION
CHOICE	string	Control what child objects the Group will load when loading the level. All All objects in the Group will be loaded. Random Chance Random chance for the sub-Groups to load based on the percentage specified by the "Randomization" property on each sub-Group. Weight Load the number of sub-Groups specified by the "Number" property based on the weight specified by the "Randomization" property on each sub-Group.
NUMBER	int	If "Choice" is set to "Weight" this is the number of sub-Groups to load. A Group will not be picked twice.
LEVEL FEATURE TAGS
NO TAG FOUND	bool	If True the Group will only be created if a Layout/Layout Link Object has no Level Feature Tag specified in its load.
TAG	string	The Level Feature Tag that will be associated with this Group.
POSITION
POSITION	CVector3	Position by X,Y,Z world coordinates.
PROPERTIES
CLASS	string	Specifying a class will make this Group always show.
DIFFICULTY MODE	string	If the difficulty mode is set, this Group and its children will only appear in that difficulty mode.
DUNGEON	string	The Group and its child objects will only appear in the specified Dungeon.
DYNAMIC	bool	If True the Group will position its child objects as well as set them visible.
LEVEL UNIQUE	bool	If True the Group and its children can only load a single time or be chosen a single time on level load.
NO ROOMPIECE COLLISION	bool	Room Pieces within the Group will have no collision.
VISIBLE	bool	Set all the Group's children visible or not.
VISIBLE IN EDITOR	bool	Set all the Group's children visible or not in the editor. Will be ignored when playing in the editor. Doesn't save.
QUEST
ACTIVE	string	The Group will only be visible if the specified Quest is active.
ACTIVE OR COMPLETE	string	The Group will only be visible if the specified Quest is active or complete.
COMPLETE	string	The Group will only be visible if the specified Quest is complete.
NOT ACTIVE OR COMPLETE	string	The Group will only be visible if the specified Quest is not active or complete.
NOT COMPLETE	string	The Group will only be visible if the specified Quest is not complete.
SHOW IN GAME MODES
GAME MODE	string	Controls what game modes the Group will appear in.
THEMES
ACTIVE THEMES	int	Themes that must be active for this Group to load.
DEACTIVE THEMES	int	Themes that must not be active for this Group to load.
WEIGHT OR RAND AS CHILD
RANDOMIZATION	int	If "Choice" is set to "Random Chance" this value ( a number between 0 - 100 ) is used as the percentage for the Group. If "Choice" is set to "Weight" this value is used as the weight for the Group.

Input Events

Show

Set all objects in the Group to be visible.

• Any Room Pieces in the Group must have "Bake" set to False to behave properly.

Hide

Set all objects in the Group to be invisible.

• Any Room Pieces in the Group must have "Bake" set to False to behave properly.

Collidable

Set all objects in the Group to be collidable.

• Any Room Pieces in the Group must have "Bake" set to False to behave properly.

Not Collidable

Set all objects in the Group to not be collidable.

• Any Room Pieces in the Group must have "Bake" set to False to behave properly.

Output Events

On Visible

This event will fire when the Group receives a "Show" Input event.

On Invisible

This event will fire when the Group receives a "Hide" Input event.