Damage Shape Object

Damage Shape

Description

This Level Object will do the specified type and amount of damage to the Units within its shape.

Location

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

Properties

Name	Type	Description	Read Only
ANGLE
ANGLE	float	The angle at which to damage 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".
DAMAGE
KNOCKBACK	float	The knockback applied upon damaging Units.
MAX	float	The maximum damage to apply.
MIN	float	The minimum damage to apply.
POSITION
POSITION	CVector3	Position by X,Y,Z world coordinates.
PROPERTIES
ALIGNMENT	string	Set the alignment type that can be damaged. All Berserk Evil EvilBerserk EvilOnly Good GoodBerserk Neutral NeutralHostile Smashable
DAMAGE SCALE	float	The scale of the base damage.
DAMAGE SOAK SCALE	float	The scale of the damage soak on impact.
DAMAGE TYPE	string	The type of damage to apply. All Electric Fire Ice Magical Physical Poison
DIRECTION	string	The direction of the damage applied. Backwards Down Forward Inward Towards Center Outward from Center Random Up
DOT	bool	If True the Damage Shape does damage over time.
ENABLED	bool	Set the Damage Shape enabled or not.
MAX UNITS TO HIT	int	The maximum number of Units that the Damage Shape can hit.
RELEASE ORDER	string	The order in which damage is applied. Clockwise Counter Clockwise Random
SHAPE	string	The shape of the Damage Shape which defines the area to be damage. Angle Box Line Point Sphere
TARGET CORPSE	bool	If True the Damage Shape will only damage corpses.
UNITTYPE	string	The Unit Type allowed to be damaged.
UPDATE IN EDITOR	bool	If True the Damage Shape will update in the editor.
RADIUS
MAX RADIUS	float	The maximum radius for the Damage Shape.
MIN RADIUS	float	The minimum radius for the Damage Shape.
USE MAX ONLY	bool	If True the Damage Shape will use only the "Max Radius".
SHAPE VISIBLE
SHAPE VISIBLE	bool	If True the "Shape" of the Damage Shape is visible (editor only).
TIMER
LOOP COUNT	int	The number of times the Damage Shape will loop.
LOOPS	bool	If True the Damage Shape will loop forever.
PAUSE TIMER	float	Set the amount of time ( in seconds ) the game will pause before starting the "Timer".
RESET ON LOOP	bool	If True the Damage Shape will reset on loop.
TIMER	float	The time ( in seconds ) the Damage Shape will do damage.

Input Events

Enable

Enable the Damage Shape object.

Disable

Disable the Damage Shape object.

Output Events

UNIT HIT

This event will fire when a Unit receives damage from the Damage Shape object.