Unit Count Sphere Object

From Runic Games Wiki
Jump to: navigation, search

Contents

Unit Count Sphere

Description

This Level Object will monitor the number of Units inside the "Radius" of the Unit Count Sphere and fire off events based on if the number reaches the set "Count" property or not. The "Ignore Unittype" and "Unittype" properties are used to specify what type of Units will be counted.

Location

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

Properties

Name Type Description Read Only
POSITION
POSITION
CVector3
Position by X,Y,Z world coordinates.
PROPERTIES
ACTIVE UNITS
bool
If True the Unit Count Sphere will only count active Units. Note: Setting this to False could cause performance issues.
ALIVE ONLY
bool
If True only alive Monsters will be counted.
COUNT
int
The count that has to be reached to fire the "Count Reached" Output event.
COUNT PETS
bool
If True pets will be counted.
COUNT SMASHABLES
bool
If True smashables will be counted.
DEAD ONLY
bool
If True only dead Monsters will be counted.
ENABLED
bool
Set the Unit Count Sphere enabled or disabled.
IGNORE UNITTYPE
string
The Unit Type to ignore and not count.
LOGIC TYPE
string
The type of logic to use for the count.
  • Equal
    If the current count is equal to the set "Count" value the "Count Reached" Output event will fire.
  • Equal or Greater Than
    If the current count is equal or greater than the set "Count" value the "Count Reached" Output event will fire.
  • Equal or Less Than
    IF the current count is equal or less than the set "Count" value the "Count Reached" Output event will fire.
PLAYER IN RADIUS
bool
If True the Unit Count Sphere will only count if the Player is in the "Radius".
RADIUS
float
The radius of the Unit Count Sphere.
SELECTABLE IN EDITOR
bool
If True the Unit Count Sphere can be selected in the Render Window in the editor.
TICK
float
The interval at which to update the current count ( in seconds ).
UNITTYPE
string
The Unit Type to count.

Input Events

Enable
Enable the Unit Count Sphere. This will allow the Unit Count Sphere to update the current count.
Disable
Disable the Unit Count Sphere. This will prevent the Unit Count Sphere from updating the current count.
Broadcast
Broadcast the Units currently in the Unit Count Sphere.

Output Events

Enabled
This event will fire when the Unit Count Sphere receives an "Enable" Input event.
Disabled
This event will fire when the Unit Count Sphere receives a "Disable" Input event.
Count Reached
This event will fire when the current count meets the set "Count" value according to the criteria set by the "Logic Type" property.
  • This event will fire repeatedly at the interval set by the "Tick" property as long as the count has been reached.
Count Not Reached
This event will fire when the current count doesn't meet the set "Count" value according to the criteria set by the "Logic Type" property.
  • This event will fire repeatedly at the interval set by the "Tick" property as long as the count has not been reached.
Personal tools
Namespaces

Variants
Actions
Navigation
Runic Sites
Toolbox