Data Actor Unit Actor

Table of Contents Data\Actor\Unit Actor Resource Preserve On Unit Remove Events Event Macros Host Sites Walk Animation Speed Model Scale Host Site Operations Selection Bonus Radius Exclude From Unit Body Selection Shape Selection Scale Aliases Hide Shadow Scale Multiplier Sprite Options

---

Data\Actor\Unit Actor {DataDataActorData-ActorUnit-Actor}

Unit actors determine how units look, sound, and animate. Units are linked to actors with the same name, and unit actors are automatically created without needing additional actor events.

Making changes to the Presentation fields of a unit will automatically create a new unit actor of the same name. Editing these fields will update the data of the linked unit actor.

Resource {Resource}

MessageType: ActorResource

The asset to use for the actor. This determines what the actor looks or sounds like.

Preserve On Unit Remove {Preserve-On-Unit-Remove}

By default, unit actor will be destroyed automatically when the unit is removed (on the UnitRemove event). When this flag is enabled enabled, the actor is not removed with the unit and must be destroyed with actor events. Enabling this flag is necessary for playing a death animations on the unit.

Events {Events}

MessageType: ActorEvent

Defines the Actor Events.

Event Macros {Event-Macros}

Event macros will be expanded after the events field.

Adds a collection of actor events to the actor via Event Macros.

Host Sites {Host-Sites}

Defines a list of named sites on this actor that other actors can be attached to (or reference).

Name {Name}

Offset {Offset}

The position of the host site, relative to the actor's origin position.

Walk Animation Speed {Walk-Animation-Speed}

Adjusts the speed of the unit's walk animation. This can be used to correct "slippery feet" on certain models.

Model Scale {Model-Scale}

Adjusts the size of the model. Using 0 defaults to 1.

Host Site Operations {Host-Site-Operations}

A set of operations applied to the host site position/rotation to determine the final position/rotation for this actor.

Selection Bonus Radius {Selection-Bonus-Radius}

Adjusts the size of this actors's hit sphere for mouse selection and targeting if the model actor is within the scope of a unit actor. Useful for making small units more click-friendly.

Can be previewed in Debug Options.

Exclude From Unit Body {Exclude-From-Unit-Body}

If checked, this actor will not be considered as part of the unit when doing hit tests or calculating the bounds of the unit. If you use this flag, make sure there is at least one Model Actor on this unit that has the Include In Unit Body flag checked.

Selection Shape {Selection-Shape}

EnumType: UnitActor.SelectionShape

Used to change mouse selection collider from sphere (default) to a cube. Useful for games with grid-based selection.

Selection Scale {Selection-Scale}

MessageType: SelectionScale

Adjusts the scale of the selection collider if Selection Shape is set to Cube.

Aliases {Aliases}

User defined name references that can be used to send messages to this actor from other actors in the same scope.

Hide Shadow {Hide-Shadow}

Prevents the actor from casting a shadow.

Scale Multiplier {Scale-Multiplier}

MessageType: InitialScale

Sets the scale of the actor across individual axes. The final scale will be these values multiplied by the Model Scale.

Sprite Options {Sprite-Options}

MessageType: SpriteOptions

Sprite options are for actor using sprite as resource.