Phase 1 of the AWS migration has been completed. If you encounter any issues, please report them through our support portal. Thank you for your patience.

Data/Actors/Events

From SC2Mapster Wiki
Jump to: navigation, search

Contents

Actor Events

Description

Actor Events are triggers which are embedded into an Actor. They listen to the surroundings and react on them. They are the "nerve-centre" of an actor. Actor events are strongly related to Actor Messages.

Hints

  • The most common use of actor events is to tell the model of the actor to play an animation such as:
    • Birth on unit Construction
    • Birth when Warping
    • Default Death on unit death
    • Burning Death on unit death
    • Acid Death on unit death
    • Attack when using a Weapon
    • Spell when using an Ability
  • Other common uses of actor events are to:
    • Swap models when upgrades have been researched
    • Swap textures or apply materials to make different units with actors that use the same model look visually distinct
    • Adjust the model scale and opacity of actors when behaviours are applied
    • Create attached Model actors
  • There are many actor events and many of them are not supported (undocumented) or applicable to all actors.

Example Usage

Birth & Death

Using the event Unit Birth, the event-source as the unit you want and the message Create you essentially connect the creation of an actor to a unit's birth. With the event Unit Death and the message Destroy you connect the destruction of an actor to the death of it's host (a unit).

Taking Damage

Site Operators

Manipulating Animations

The Messages Animation Bracket Start,Animation Bracket Stop, Animation Play and Animation Clear are the most common used here. Each Animation has to be declared under the Name field for future reference. Animation Properties is the actual animation-name you want to play on your actor based on the model used by the actor. Animation Play and Animation Clear only handle one animation, while Animation Bracket Start and Animation Bracket Stop are handling 3 animations, one Opening animation (that plays once), one Content animation that gets looped until the Animation Bracket Stop message executes the Closing animation once, bringing the animation-bracket to an end.

Facing and Look At

Flying units and bankers

Banking is a flight term that refers to the tilt of the airplane when it is turning. Of course, flying units in StarCraft II does not have any aerodynamic features, so they need to be simulated using "bankers".

Model Events

Texture and Model Swaps

List of Actor Events

Events are the conditions that result in Actions being performed. Many are triggered when Actions of the same name are applied to the actor.

Ability

Triggered when an ability is used at a certain stage. Can either make the ability the host of this actor (if the actor is created by this event) or if this actor already has a host (e.g. a unit or other actor) the Ability event can be used for the actor to do something as a reaction (e.g. play an animation).

Ability Charge

Ability Cooldown

Ability Morph

Ability Rally

Ability Train

Action Impact

Action Impact Physics

Action Target Teleport

Activate Think Message

Activate Update Message

Actor Copy

Actor Creation

Triggered when the actor has been created. Use this if you want to setup animations (e.g. Birth-Stand-Death Animation brackets), sounds or anything else that has to be present at and beyond the actor's creation point.

Actor Destruction

Triggered when the actor is being destroyed (via the Destroy message). Used in cases you want to manipulate (Create, destroy, tint etc.) other actors at the Ending-Point of an actor.

Actor Orphan

Triggered when an actor lost the connection to its host (e.g. its unit, if the unit dies and there is no Destroy message at the actor catching this case). Used as "failsafes" when actors are created by effects and abilities as their hosts, to have the actor destroyed when the host has finished at last.

Actor Site Operation Dump

Actor Think

Actor Update

Add

Add Pitch

Add Roll

Add Yaw

Age Reached

Alias Add

Alias Dump

Alias Remove

Anim Continue

Anim Set Time Scale From

Anim Set Time Scale Global From

Animation Baseline Start

Animation Baseline Stop

Animation Bracket Clear

Animation Bracket Resume

Animation Bracket Start

Animation Bracket State

Animation Bracket Stop

Animation Clear

Animation Clear Except

Animation Done

Triggered when an animation finishes. Can be further specified in the Sub Name field to only trigger when the animation was played correctly (-> loaded successfully).

Animation Dump Data

Animation Global Loop Clear

Animation Global Loop Start

Animation Global Loop Stop

Animation Group Apply

Animation Group Remove

Animation Group Remove All

Animation Play

Animation Set Completion

Animation Set Duration

Animation Set Locked

Animation Set Paused

Animation Set Paused All

Animation Set Time

Animation Set Time Scale

Animation Set Time Scale (Absolute)

Animation Set User Weight

Apply Animation Blend Time

Arrived

Aspect Confirm

Aspect Test

Asset Pre Initialization

Attach Dump

Attach Model

Attach Model Offset

Attach Offset

Attach Set Bearings

Attachment Set Bearings

Attachment Set Position

Attachment Set Position From

Attachment Set Rotation

Attachment Set Rotation From

Behavior

Behavior Level

Behavior Stack Item

Billboard Set Towards Camera Distance

Camera Proximity Update

Camera Set Active

Camera Set Eye Position

Camera Set Link

Camera Set Parameter

Camera Shake Start

Camera Shake Stop

Cancel Active Animation Blends

Clear Combat Reveal Timers

Clear Filter

Clear Filter Players

Clear Global Animation Time Scale

Clear Local Tint Color

Clear Opacity

Clear Scale

Clear Team Color

Clear Tint Color

Combat Reveal Complete

Command UI

Confirmation

Create

Create Copy

Creep

Creep Engulfment Start

Creep Engulfment Start Transition

Creep Engulfment Stop

Creep Engulfment Stop Transition

Cursor Update

Curve Add

Curve Add Label

Curve Add Point

Curve Done

Curve Start

Curve Stop

Curve Stop Looping

Custom Portrait

Cutscene

Cutscene Add Filter

Cutscene Bookmark

Cutscene Clear Filters

Cutscene Go To Bookmark

Cutscene Pause

Cutscene Play

Cutscene Remove Filter

Cutscene Set

Cutscene Set Filters

Cutscene Set Time

Cutscene Step Bookmark

Cutscene Stop

Death Custom

Death Custom Set Synchronous Pass Chance

Death Customs Dump

Death Customs Enable Physics

Death Model Initialize Done

Destroy

Destroy Particles

Destroy Ribbons

Doodad Preserve

e_actorMSGButtonHover

Editor Map Initialize

Effect

Enable Render To Texture

Execute

External Finder Add

External Finder Remove

Filter Update

Flyer Helper Change

Force Set Angle

Force Set Height

Force Set Length

Force Set Magnitude

Force Set Radius

Force Set Width

Forward

Game Initialize

Glow Start

Glow Stop

Halo Clear Color

Halo Set Color

Halo Set Color From Alliance Type

Halo Start

Halo Stop

Herd Level

Herd Speed

Hide Worker Count

Hook Clear

Hook Dump

Hook Set

Host Set Offset

Host Site Operations Set

Hosted Properties Dump All

Hosted Property Dump

Item

Light Set Ambient Occlusion

Light Set Attenuation Start

Light Set Colour Multiplier

Light Set Falloff

Light Set Hotspot

Light Set Opaque

Light Set Range

Light Set Shadow Casting

Light Set Specular

Light Set Specular Color

Light Set Transparent

List Add

List Remove

Look At Aquire Target

Look At Disengage

Look At Dump Turret Groups

Look At Engage

Look At Set Type

Look At Start

Look At Stop

Maximize Priority

Minimap Icon

Minimap Icon Background

Minimap Icon Background Scale

Minimap Icon Background Tint Color

Minimap Icon Scale

Minimap Icon Tint Color

Minimap Tooltip

Missile Tentacle Retracted

Model Allow Hit Test

Model Animate Invisible

Model Aspect Applied

Model Aspect Start

Model Aspect Stop

Model Event

Model Event Suppress

Model Flags Clear

Model Flags Set

Model Link Customize

Model Link Customize Special

Model Material Apply

Model Material Apply To

Model Material Dump

Model Material Remove

Model Material Remove(2)

Model Sudden Motion Start

Model Sudden Motion Stop

Model Swap

Model Swap Stack Pop

Model Swap Stack Push

Model Swapped

Motion Phase Start

Motion Phase Stop

Move

Movement Tracking Start

Movement Tracking Stop

Mover Stopped

Options Changed

Physics Body Bump

Physics Cloth Collision Volume Set Link

Physics Impact

Physics Impact Customize

Physics Impact Terrain Reject

Physics Impact Terrain Validate

Physics Impacts Enable

Physics Initialize

Physics Match Keys Ordered Dump

Physics Match Keys Ordered Set

Physics Material Override

Physics Material Restore

Physics Terminate

Play Sequence

Play Unit Sound

Portrait Animation Set Time

Portrait Think

Portrait Update

Pre Selection Update

Pre Targeting Update

Prepare

Print

Progress Level

Query Persistent

Query Radius

Query Region

Range Update

Reference Clear

Reference Create

Reference Destroy

Reference Dump

Reference Notify

Reference Set

Reference Set From Msg

Reference Set From Request

Reference Set Refresh Name

Reference Table Dump

Region Subject

Remove

Remove All

Remove Animation Blend Time

Run Macro

Scene Halo Set Color

Scene Halo Set Emission

Scene Halo Set Width

Scene Particles Destroy

Scene Physics Impact Spy

Scene Physics init Failure Spy=

Scene Power Show All

Scene Ribbons Destroy

Scene Skybox Set

Scene Strobe Set Cycle Length

Scene Strobe Set Falloff

Scene Strobe Set Height

Scene Texture Dump File Aliases

Scene Texture register File Aliases

Select By Match

Select By Slot

Selection Flash (Local)

Selection Flash (Sync)

Selection Subgroup Update (Local)

Selection Subgroup Update (Sync)

Selection Update (Local)

Selection Update (Sync)

Set

Set Acceleration

Set Angle

Set Bearings

Set Bearings (Height)

Set Bearings From

Set Camera Set To Bounds

Set Cast Shadows

Set Deceleration

Set Destination From

Set Destination Height (Absolute)

Set Destination Height (Relative)

Set Destination Position

Set Facing

Set Filter

Set Filter Players

Set Group Icon

Set Height

Set Hero Icon

Set Material Visibility

Set Minimap Visibility

Set Minimap Visibility Always

Set Opacity

Set Player Id

Set Position

Set Position (Height)

Set Position 2D

Set Position From

Set Position Height (Absolute)

Set Position Height (Relative)

Set Reference From Actor

Set Ring Radius

Set Rotation

Set Rotation From

Set Rotation Yaw/Pitch/Roll

Set Scale

Set Scale Absolute

Set Scale From Weapon Range

Set Sound Reverb Balance (Direct)

Set Sound Reverb Balance (Room)

Set Sound Suffix

Set Speed

Set Speed Maximum

Set Status Bar On

Set Team Color

Set Team Color Blend

Set Team Color From

Set Text

Set Text (Localized)

Set Text Color

Set Text Size

Set Time Scale Global

Set Tint Color

Set Tint Color (Local)

Set Tint Color Blend

Set Transfer Override Animation

Set Unit Icon

Set Visibility

Set Visible To

Set Visible To Players

Set Walk Animation Move Speed

Set Wireframe

Set Wireframe Shield

Show Status Bar

Signal

Snapshot Creation

Sound Add Digital Effect

Sound Done

Sound Link Customize

Sound Set Muted

Sound Set Offset

Sound Set Paused

Sound Set Pitch

Sound Set Volume

Spotlight Update

Squib Choice

State Change

Status Decrement

Status Increment

Status Off

Status On

Status Set

Stop

Stop Immediately

Strobe Start

Strobe Stop

Supporter Destruction

Supress Walk

Take Snapshot

Tentacle Return

Terrain Physics Material Enter

Terrain Physics Material Leave

Terrain Physics Reinitialize

Terrain Squib

Terrain Squib Activate Group

Terrain Squib Deactivate

Texture Dump

Texture Dump Database

Texture Group Apply

Texture Group Apply Global

Texture Group Remove

Texture Group Remove Global

Texture Reset

Texture Select By File Alias

Texture Select By Id

Texture Select By Update Link

Texture Select Decal By Player

Texture Update

Texture Video Play

Texture Video Set Frame

Texture Video Set Paused

Texture Video Set Time

Texture Video Set Time(2)

Texture Video Stop

Texture Video Stop All

Texture Video Time Override

Timer Expired

Timer Kill

Timer Set

Transition

Transmission Play

Transmission Stop

Transport

Turret Disable

Turret Enable

Turret Fidget

Turret Rotation

Turret Rotation Update

Turret Target

UI Status Flag Set

Unit Attacked

Unit Attacker

Unit Birth

Unit Blip Update

Unit Call For Help

Unit Click

Unit Click Local

Unit Construction

Unit Creation

Unit Damaged

Unit Death

Unit Death Custom

Unit Death While Hidden

Unit Detected By Viewer

Unit Fidget

Unit Height

Unit Highlight

Unit Highlight Local

Unit Movement Update

Unit Player Change

Unit Point

Unit Portrait

Unit Refund

Unit Regeneration

Unit Revive

Unit Shrub Update

Unit Taunt

Upgrade

Upgrade Finalized

Walk Animation Move Speed

Weapon

Weapon Critical Update

Weapon Start

Weapon Stop

Events not available in Data Module

Events not available in the data editor but some do seem to work: Not all have been tested yet. The only way to impement them is to edit the Event - Events - Terms field with View Raw Data enabled which leaves the Source Name and Sub Name values that work with them as (Unknown). The string needed to be entered to refer to them is not always the same as what they are called!

Abstract

Action

Action Center

Action Commence

Action Participants

Actor

Animation

Animation Loaded

Animation Properties

Animation Set Slaved Time

Attachment Methods

Effect Action

Effect Impact Update

Facial Play

Facial Stop

Generic

Internal

Look At

Missile

Missile (Pre Host)

Motion Phase

Name

None

Override Age

Parameters

Reference Name

Reset Other Blocks

Set From

Set Mimic Player

Set Queried Spawn

Set Team Color Index

Texture Properties

Turret

Unit

Update Team Color

Update Visibility

User

Weapon

Terms

  • Terms are additional conditions that have to be met for the Action to take place
  • Some terms are only available for specific events

Ability Cmd

Ability Cmd Smart

Ability Key

Ability Key Any

Ability Level

Ability Train Produced

Ability Transport

Age

AI UI Mode

Animation Baseline State

Animation Bracket Exit Reason

Animation Name

Animation Playable

Animation Playing

Animation Playing Name

Animation Playing Props

At

Attach

Button Enabled

Can Apply Action Physics

Cap

Compare Field

Creep Can Engulf

Creep Engulfs

Creep Intersects

Cutscene Status

Death

Effect Execute Index

Effect Parent

Effect Period Index

Exclude

Flyer Helper

From Effect Tree Descendant

Game

Game Speed

Game Time

Has Alliance Type With

Has Scope Flag

Has Status

Height

Is Actor Local Player

is Color Blind

Is During Replay

Is In Editor

Is Known As

Is Local Participant Type

Is Status

Is Underwater

Keys

Killed By

Killed By Effect

Level

Missile Tentacle

Missile Tentacle Is Returning

Model Event Name

Model Is Low Quality

Model Material Applied

Model Name

Model Swap From

Model Swap To

Model Variation

Morph From

Morph To

Motion Phase

Movement Net Over Interval

Mover Link

Msg

Option

Order Display Type

Orphaned

Overkill Type

Pass Chance

Physics Impact Classify

Physics Impact Classify Combo

Physics Impact Collision Area

Physics Impact Density

Physics Impact Environment

Physics Impact From Floating

Physics Impact Impulse

Physics Impact Material

Physics Impact Material Combo

Physics Impact Material Relative Hardness

Physics Impact Participant Is Known As

Physics Impact Relative Approach Speed

Player Decal

Player Has Clan Decal

Player Has Reward

Player Has Trophy

Player Id

Portrait Actor

Portrait Model

Property Curve Name

Ref Equals

Ref Exists

Require

Scope

Scope Contains

Selected

Sound Is Final Sound

Speed

Squib

State Changed

State Valid

Sub Name

Supported By

Taunt

Team Id

Terrain Physics Material

Terrain Physics Material At Actor

Texture File Alias Is Valid

Texture Groups Global

Texture Slot Satisfies Expression

Texture Update Link

Texture Update Slot

Timer Name

Unit Walking

Validate Base

Validate Creation Effect

Validate Effect

Validate Morph From

Validate Morph To

Validate Player

Validate Portrait Unit

Validate Position

Validate Unit

Validate Unit Type

Viewer Treats Unit As

Weapon Target Angle

Weapon Target Distance

Weapon Target Elevation

Actions

Each Event can only have one action which is the effector for the event performing some alteration to the actor

Action Damage

Action Damage Physics

Action Impact

Action Impact Physics

Activate Think Message

Activate Update Message

Actor Site Operation Dump

Add

Add Pitch

Add Roll

Add Yaw

Alias Add

Alias Dump

Alias Remove

Animation Continue

Animation Set Time Scale From

Animation Set Time Scale Global From

Animation Baseline Start

Animation Baseline Stop

Animation Bracket Clear

Animation Bracket Resume

Animation Bracket Start

Animation Bracket State

Animation Bracket Stop

Animation Clear

Animation Clear Except

Animation Copy

Animation Dump Data

Animation Global Loop Clear

Animation Global Loop Start

Animation Global Loop Stop

Animation Group Apply

Animation Group Remove

Animation Group Remove All

Animation Play

Animation Set Completion

Animation Set Duration

Animation Set Locked

Animation Set Paused

Animation Set Paused All

Animation Set Time

Animation Set Time Scale

Animation Set Time Scale (Absolute)

Animation Set User Weight

Apply Animation Blend Time

Aspect Confirm

Attach

Attach Dump

Attach Model

Attach Model Offset

Attach Offset

Attach Set Bearings

Attachment Set Bearings

Attachment Set Position

Attachment Set Position From

Attachment Set Rotation

Attachment Set Rotation From

Billboard Set Towards Camera Distance

Camera Set Active

Camera Set Eye Position

Camera Set Link

Camera Set Parameter

Camera Shake Start

Camera Shake Stop

Cancel Active Animation Blends

Clear Combat Reveal Timers

Clear Filter

Clear Filter Players

Clear Global Animation Time Scale

Clear Local Tint Color

Clear Opacity

Clear Scale

Clear Team Color

Clear Tint Color

Combat Reveal Complete

Create

Create Copy

Creep Engulfment Start

Creep Engulfment Start Transition

Creep Engulfment Stop

Creep Engulfment Stop Transition

Curve Add

Curve Add Label

Curve Add Point

Curve Start

Curve Stop

Curve Stop Looping

Custom Portrait

Cutscene Add Filter

Cutscene Clear Filters

Cutscene Got To Bookmark

Cutscene Pause

Cutscene Play

Cutscene Remove Filter

Cutscene Set

Cutscene Set Filters

Cutscene Set Time

Cutscene Step Bookmark

Cutscene Stop

Death Custom

Death Custom Set Synchronous Pass Chance

Death Customs Dump

Death Customs Enable Physics

Destroy

Destroy Particles

Destroy Ribbons

Doodad Preserve

Enable Render To Texture

Execute

  • (Unknown)

External Finder Add

External Finder Remove

Filter Update

Force Set Angle

Force Set Height

Force Set Length

Force Set Magnitude

Force Set Radius

Force Set Width

Forward

Glow Start

Glow Stop

Halo Clear Color

Halo Set Color

Halo Set Color From Alliance Type

Halo Start

Halo Stop

Hide Worker Count

Hook Clear

Hook Dump

Hook Set

Host Set Offset

Host Site Operations Set

Hosted Properties Dump All

Hosted Property Dump

Light Set Ambient Occlusion

Light Set Attenuation Start

Light Set Colour Multiplier

Light Set Falloff

Light Set Hotspot

Light Set Opaque

Light Set Range

Light Set Shadow Casting

Light Set Specular

Light Set Specular Color

Light Set Transparent

List Add

List Remove

Look At Aquire Target

Look At Disengage

Look At Dump Turret Groups

Look At Engage

Look At Set Type

Look At Start

Look At Stop

Maximize Priority

Minimap Icon

Minimap Icon Background

Minimap Icon Background Scale

Minimap Icon Background Tint Color

Minimap Icon Scale

Minimap Icon Tint Color

Minimap Tooltip

Model Allow Hit Test

Model Animate Invisible

Model Event Suppress

Model Flags Clear

Model Flags Set

Model Link Customize

Model Link Customize Special

Model Material Apply

Model Material Apply To

Model Material Dump

Model Material Remove

Model Material Remove(2)

Model Sudden Motion Start

Model Sudden Motion Stop

Model Swap

Model Swap Stack Pop

Model Swap Stack Push

Move

Movement Tracking Start

Movement Tracking Stop

Physics Body Bump

Physics Cloth Collision Volume Set Link

Physics Impact

Physics Impact Customize

Physics Impact Terrain Reject

Physics Impact Terrain Validate

Physics Impacts Enable

Physics Initialize

Physics Match Keys Ordered Dump

Physics Match Keys Ordered Set

Physics Material Override

Physics Material Restore

Physics Terminate

Play Sequence

Play Unit Sound

Portrait Animation Set Time

Pre Targeting Update

Prepare

Print

Query Persistent

Query Radius

Query Region

Range Update

Reference Clear

Reference Create

Reference Destroy

Reference Dump

Reference Notify

Reference Set

Reference Set From Msg

Reference Set From Request

Reference Set Refresh Name

Reference Table Dump

Remove

Remove All

Remove Animation Blend Time

Run Macro

Scene Halo Set Color

Scene Halo Set Emission

Scene Halo Set Width

Scene Particles Destroy

Scene Physics Impact Spy

Scene Physics init Failure Spy=

Scene Power Show All

Scene Ribbons Destroy

Scene Skybox Set

Scene Strobe Set Cycle Length

Scene Strobe Set Falloff

Scene Strobe Set Height

Scene Texture Dump File Aliases

Scene Texture register File Aliases

Select By Match

Select By Slot

Set

Set Acceleration

Set Angle

Set Bearings

Set Bearings (Height)

Set Bearings From

Set Camera Set To Bounds

Set Cast Shadows

Set Deceleration

Set Destination From

Set Destination Height (Absolute)

Set Destination Height (Relative)

Set Destination Position

Set Facing

Set Filter

Set Filter Players

Set Group Icon

Set Height

Set Hero Icon

Set Material Visibility

Set Minimap Visibility

Set Minimap Visibility Always

Set Opacity

Set Player Id

Set Position

Set Position (Height)

Set Position 2D

Set Position From

Set Position Height (Absolute)

Set Position Height (Relative)

Set Reference From Actor

Set Ring Radius

Set Rotation

Set Rotation From

Set Rotation Yaw/Pitch/Roll

Set Scale

Set Scale Absolute

Set Scale From Weapon Range

Set Sound Reverb Balance (Direct)

Set Sound Reverb Balance (Room)

Set Sound Suffix

Set Speed

Set Speed Maximum

Set Status Bar On

Set Team Color

Set Team Color Blend

Set Team Color From

Set Text

Set Text (Localized)

Set Text Color

Set Text Size

Set Time Scale Global

Set Tint Color

Set Tint Color (Local)

Set Tint Color Blend

Set Transfer Override Animation

Set Unit Icon

Set Visibility

Set Visible To

Set Visible To Players

Set Walk Animation Move Speed

Set Wireframe

Set Wireframe Shield

Show Status Bar

Signal

Sound Add Digital Effect

Sound Link Customize

Sound Set Muted

Sound Set Offset

Sound Set Paused

Sound Set Pitch

Sound Set Volume

Status Decrement

Status Increment

Status Set

Stop

Stop Immediately

Strobe Start

Strobe Stop

Supress Walk

Take Snapshot

Tentacle Return

Terrain Physics Reinitialize

Terrain Squib Activate Group

Terrain Squib Deactivate

Texture Dump

Texture Dump Database

Texture Group Apply

Texture Group Apply Global

Texture Group Remove

Texture Group Remove Global

Texture Reset

Texture Select By File Alias

Texture Select By Id

Texture Select By Update Link

Texture Select Decal By Player

Texture Video Play

Texture Video Set Frame

Texture Video Set Paused

Texture Video Set Time

Texture Video Set Time(2)

Texture Video Stop

Texture Video Stop All

Texture Video Time Override

Timer Kill

Timer Set

Transition

UI Status Flag Set

Walk Animation Move Speed

https://www.sc2mapster.com/forums/development/data/20528-actor-fading-an-actor-in-and-out-with-timer-events