Data Actor Model Actor - BLKTower/TestWiki GitHub Wiki

Table of Contents

Data\Actor\Model Actor {DataDataActorData-ActorModel-Actor}

Model actors are used for all non-unit visuals and sound effects in the game. Each individual visual effect or sound has its own model actor. Shares many fields with Unit Actor.

Resource {Resource}

MessageType: ActorResource

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

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 Site {Host-Site}

Where this actor will be attached to in the actor scope. It can be the name of an actor (that actor will be used as the parent and this actor will be attached to its origin point), or a host site defined in an actor (that actor will be used as the parent and the referenced site will be the attach point), or an attachment defined in the model of an actor.

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.

Host Sites {Host-Sites}

Define 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.

Additional Resources {Additional-Resources}

MessageType: ActorResource

If set, a random resource will be chosen from a list comprised of this list and the Resource Name. This is useful for playing random voice lines, among other uses.

Model Scale {Model-Scale}

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

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.

Aliases {Aliases}

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

Include In Unit Body {Include-In-Unit-Body}

When enabled, the model actor counts as selectable when within the scope of a unit actor.

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.

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.

⚠️ **GitHub.com Fallback** ⚠️