Unit Spawner Object

Unit Spawner

Description

This Level Object will spawn a Unit in the world.

Location

Right-click on an empty space in the Layout Scene Manager and choose Logic > Unit Spawner from the list.

Properties

Name	Type	Description	Read Only
ANGLE
ANGLE	float	The angle at which to spawn Units.
ANGLE OFFSET	float	The "Angle" minus the specified offset.
BOX SIZE
SIZE	CVector3	The size of the box ( X = width, Y = height, Z = length ) if the "Shape" property is set to "Box".
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
DEATH PAUSE	float	The pause that will occur after a Monster dies and before the next Monster can spawn. Only used if "Max Count" value is smaller than "Count" value.
DESTROY BODY	bool	If True spawned Monster meshes will be destroyed on death.
DIRECTION	string	The direction the Unit will face once spawned. Backwards Down Forward Inward Towards Center Outward from Center Random Up
DURATION	float	The duration to release the Units in.
ENABLED	bool	Set the Unit Spawner enabled or not.
FADE BODY	bool	If True spawned Monsters will fade out when they die.
GIVE LOOT	bool	If True Monsters will drop loot on death.
GIVE XP	bool	If True Monsters will give XP on death.
HP MOD	float	Modifies the max health points of the spawned Monsters.
IGNORE UNIT OCCUPATION	bool	Ignore passability occupation from other Units.
ITEMS FLIPOUT	bool	If True Items will play a flip out animation when spawned.
MAX ALLOWED	bool	The maxiumum number of Monsters allowed to be alive at a time.
MONSTER WANDER	float	Distance the Monster will wander from the Position of the Unit Spawner.
MUST SPAWN	bool	If True the Unit Spawner must spawn the unit even if the area is unpathable.
PLAY SPAWN ANIM	bool	Monsters only: If true the Monster will play its spawn animation if it has one.
PULSE RATE	bool	The number of pulses that occur. This will spawn the number of Units per pulse.
QUEUED ENV ANIM	string	An environmental animation the Monster Object will play after the "Spawn Animation" has finished.
RELEASE ORDER	string	The order in which the Units are spawned. Clockwise Counter-Clockwise Random
REQUIRES LOS	bool	If True the Unit requires line-of-sight from the Unit Spawner to be spawned.
RESPAWN TIME	float	The time between character death and respawn (0 for no respawn).
RESPAWN TIME MIN	float	Minimum time between character death and respawn (will always use "Respawn Time" if 0).
SHAPE	string	The shape of the Unit Spawner which defines the area Units are spawned in. Angle Box Line Point Sphere
SNAP TO GROUND	bool	Items and Monsters snap to the ground when spawned.
SPAWN ANIM	string	The spawn animation to play when the Monster is spawned.
SPAWN AT UNIT	string	The name of a specific Unit to spawn at.
SPAWN IN CENTER	bool	Items and Monsters only: If True the Units will spawn in the center of the Unit Spawner regardless of "Shape".
SPAWN ON ANY CLIENT	bool	If True the Units will spawn on any multiplayer client.
SPAWN ON CREATE	bool	If True the Unit Spawner will spawn Units on level load.
SPAWN ONCE	bool	If True the Unit Spawner will only spawn once.
SPAWNING	string	Special idle spawn animations.
TARGET PLAYER	bool	Monsters only: If True the Monsters will target the Player when spawned.
UNIQUE IN WORLD	bool	If True the Unit will not spawn if there is another one in the world. Only works for Monsters and Items.
UNIT LEVEL DELTA	int	Modify the level of spawned Units by this amount.
UPDATE IN EDITOR	bool	If True the object will visually update in the editor.
WANDER ON SPAWN	bool	If True the Unit will wander once spawned.
RADIUS
MAX RADIUS	float	The maximum radius for the Unit Spawner.
MIN RADIUS	float	The minimum radius for the Unit Spawner.
USE MAX ONLY	bool	If True only the "Max radius" will be used.
RESOURCES
FORCE SPAWNCLASS	bool	If True, and "Group" is "Spawn Class", all the objects chosen from the Spawn Class will be spawned.
GROUP	string	Filters the list displayed in "Resource" by group. Items Missiles Monsters Particle Props Spawn Class Unit Type
RESOURCE	string	This determines what Unit is spawned.
SHAPE VISIBLE
SHAPE VISIBLE	bool	If True the "Shape" of the Unit Spawner is visible (editor only).
SPAWNCOUNT
COUNT	int	The maximum number of Units to spawn.
MIN COUNT	int	The minimum number of Units to spawn. If set to -1 only the "Count" is used.

Input Events

Enable

Enable the Unit Spawner.

Disable

Disable the Unit Spawner. The Unit Spawner will not spawn any more Units and won't accept "Spawn Units" Input events.

Spawn Units

Spawn the specified Units.

• This event will reset the Unit Spawner if it is currently Enabled.

Stop

Stop spawning the specified Units.

• The Enabled state of the Unit Spawner will not change. If Enabled it will accept "Spawn Units" Input events.

Destroy Spawned Units

Destroy/Kill all spawned Units and stop spawning further Units.

Destroy and then Spawn Units

Destroy/Kill all spawned Units and spawn new Units.

• This will fire the "Unit Spawned" Output event.

Hide And Disable Spawned Units

Increment Level Delta

Increment the level of the spawned Units by 1.

• This will not change the level of already spawned Units.

Decrement Level Delta

Decrement the level of the spawned Units by 1.

• This will not change the level of already spawned Units.

Set Target

Set the passed Player or Monster as the target for spawned Units.

All Units Spawned?

Checks if all Units set on the Unit Spawner have been spawned. If so, fire the "All Units Spawned" Output event.

All Monsters Dead?

Checks if all Monster Objects spawned by the Unit Spawner have been killed.

• If True it will fire the "All Monsters Dead" Output event.
• If False it will fire the "All Monsters NOT Dead" Output event.

Output Events

All Units Spawned

This event will fire when all Units set on the Unit Spawner have been spawned. It will also fire after the "All Monsters Dead?" Input event is fired and returns True.

Monster Killed

This event will fire when any Monster spawned by the Unit Spawner is killed.

All Monsters Dead

This event will fire when all Monsters spawned by Unit Spawner have been killed.

Item Picked Up

This event will fire when an Item spawned by the Unit Spawner is picked up by the Player.

All Items Picked Up

This event will fire when all Items set on the Unit Spawner have been spawned and picked up by the Player.

Item Interacted

All Items Interacted With

All Monsters NOT Dead

This event will fire after the "All Monsters Dead?" Input event is fired and returns False.

Unit Spawned

This event will fire when a Unit is spawned by the Unit Spawner.

• This will also pass the spawned Unit to another object.

Tutorials

• Spawn a Monster