Unit (Actor)

Unit

(Editor Screenshot) need picture of any units

Description

Main actor used to give units (the data type) a visual form. This actor dictates what the unit looks like, the sounds it makes when clicked/ordered, the armor textures, the kill rank texts, the portrait for the unit, the picture shown when the unit is selected and the minimap icon for the unit.

Hint

If you want to make a unit you require one of these though having more than one at any given time causes an error message

Example Usage

Leviathan

The Leviathan is a unit and has a unit actor like any other. The Leviathan actor is used as the host for the four tentacle Model actors which are atached to the hardpoints of the Leviathan model. The Events+ fields determine how the unit responds when casting/attacking, what animations it plays on birth and death and creates the four attached tentacles.

URL

As Leviathan is already in the campaign dependencies no URL is needed

Example Name 2

(Description from a global overview, tell us the relationship of combined data objects to this object)

URL

(URL to the real example, because we could use 1 example for 5 different objects)

Fields Description

Actor - Add To Proximity System

• (Unknown)

Actor - Aliases

• Aliases that refer to the unit in Events

Actor - Filter

• Determines what players can see the actor depending on their diplomatic status eg. Nuke Target/Indicator

Actor - Flags

• Add To External Finder (Unknown)
• Not Saved (Unknown) used by all tempory Model actors
• Scale To Host overides any scaling the actor has and sets it to the host Unit actor
• Suppress Creation Errors (Unknown)

Actor - Fog Visibility

• Determines how the actor appears under the fog of war
• Not sure how it interacts with the UI - Fog Visibility under the Units data type

Actor - Local Offset For 2nd Visibility Test

• (Unknown)

Actor - Portrait Actor

• (Unknown) comes up with an error if set to anything other than PortraitActor

Actor - Proximity Position

• Center Actor (Unknown)
• Center Model Bounds (Unknown)

Actor - Sharing

• Determines to what degree the same actor is shared by a unit if there are multiple functions refering to it
• Always means the actor is always shared
• None means the actor is never shared
• Per Effect Tree means that effects within an effect tree share the actor but different effect trees can't

Actor - Snapshot Actor

• (Unknown) comes up with an error if set to anything other than Snapshot

Animation - Animation Blend Time

• Affects the animation blend times for the model
• -1 Sets the blend time to the global animation blend time scale

Animation - Animation Turn Duration

• (Unknown)

Animation - Baselines - Animation Properties

• (Unknown)

Animation - Baselines - Blend In

• (Unknown)

Animation - Baselines - Blend Out

• (Unknown)

Animation - Glossary Animation

• The animation the unit plays when viewed in the glossary

Animation - Variance Window - Stand

• (Unknown)

Animation - Variance Window - Stand Intro

• (Unknown)

Animation - Variance Window - Walk

• (Unknown)

Animation - Variance Window - Walk Intro

• (Unknown)

Animation - Variance Window - Walk Outro

• (Unknown)

Animation - Walk Animation Movement Speed

• How fast the unit looks like it is walking
• Adjust this relative to the speed your unit moves at

Art - Auto Scale Factor

• The scaling factor for all three dimensions unless specified otherwise

Art - Auto Scale From Selection Factor

• (Unknown)

Art - Model

• The model used for this actor
• Set under Models data type

Art - Model (Build)

• The model used for the build animation when the unit is under construction

Art - Model (Editor)

• The placeholder model for looking at in the terrain editor
• Default is (None)

Art - Model (Placement)

• The semitransparent version of the model used when placing the unit/building in the editor and ingame

Art - Model (Portrait)

• The model used for the portrait of the unit

Art - Model Flags

• Allow Hit Test
  • Makes the Actor's model hittable by missiles? (Can use by attaching additional models to a unit which would increase the volume which missiles can hit.)
• Ignore Walkables (Unknown)
• Needs Volume Monitor (Unknown)
• Suppress Missing Attachment Errors (Unknown)
• Suppress Player Decals
  • Removes player decals from the model.
• Update Visibility (Unknown)
• Use Synchronous Seed
  • Makes it so random checks for the model return the same for all players in an online game (probably with regard to randomizing variations, etc.).

Art - Placeholder Actor Model

• (Unknown)

Art - Placement Model

• (Unknown)

Art - Random Scale Range

• A random value between the minimal and maximum is chosen and applied to the x, y and z dimensions of the model

Art - Scale

• Scale of the model in the x, y and z dimensions
• The scale can also be set under the model used in the models data type

Combat - Custom Death - Animation Properties

• The animation played for the custom death

Combat - Custom Death - Model

• The model created for the custom death

Combat - Custom Death - Name

• The string of the custom death refered to by the Death Custom event

Combat - Custom Death - Physics Delay

• (Unknown)

Combat - Custom Death - Sound

• Sound played when the unit undergoes the custom death

Combat - Custom Death - Voice Link

• (Unknown)

Combat - Death Actor Model

• The actor that controls the Combat - Death Effects - Model shown on unit death

Combat - Death Actor Model Low

• The actor that controls the Combat - Death Effects - Model shown on unit death when graphics are set to low quality

Combat - Death Actor Sound

• The actor that controls the Combat - Death Effects - Sound when the unit dies

Combat - Death Actor Voice

• The actor that controls the Combat - Death Effects - Voice Link when the unit dies

Combat - Death Effects - Animation Properties

• The animation tags determining the Combat - Death Effects - Model animations that are played on each death type

Combat - Death Effects - Model

• The model used for the death effects when killed by each death type

Combat - Death Effects - Physics Delay

• (Unknown)

Combat - Death Effects - Sound

• The sound from the Sounds data type played on unit death when destroyed by each death type

Combat - Death Effects - Voice Link

• (Unknown)

Event - Event Footprint - Actor

• (Unknown)

Event - Event Footprint - Model

• (Unknown)

Event - Event Footprint - Name

• (Unknown)

Event - Event Footprint Actor

• (Unknown)

Event - Event Sound - Actor

• (Unknown)

Event - Event Sound - Name

• (Unknown)

Event - Event Sound - Sound

• (Unknown)

Event - Event Sound Actor

• (Unknown)

Event - Events+

• Series of minitriggers that determine the motions and visual effects of the actor
• Make sure the various events resulting in the actor creation are linked to the desired unit
• More details about the actor events here.

Event - Macros

• The Event Macro actors used to supplement the events

Event - Remove - Send

• (Unknown)

Event - Remove - Target

• (Unknown)

Event - Remove - Terms

• (Unknown)

Event - Terms

• (Unknown)

Hosting - Host - Actor

• Actor Find (Not Sure) means the actor has to be found using the scope
• Creation (Not Sure) is the actor that creates this actor is given priority for hosting if there is a choice of several
• Implicit is the default

Hosting - Host - Effect

• (Unknown)

Hosting - Host - Fail If No Host

• Causes the model to be automatically destroyed if no host

Hosting - Host - Scope

• Implicit is the default
• Scope Caster (Unknown)
• Scope Effect (Unknown)
• Scope Missile (Unknown)
• Scope Outer (Unknown)
• Scope Source (Unknown)
• Scope Target (Unknown)

Hosting - Host - Subject

• The actor that this actor is hosted on
• Can use _Unit or _Selectable for undefined hosting eg. buffs

Hosting - Host For Properties - Actor

• Actor Find (Not Sure) means the actor has to be found using the scope
• Creation (Not Sure) is the actor that creates this actor is given priority for hosting if there is a choice of several
• Implicit is the default

Hosting - Host For Properties - Effect

• (Unknown)

Hosting - Host For Properties - Fail If No Host

• Causes the model to be automatically destroyed if no host

Hosting - Host For Properties - Scope

• Implicit is the default
• Scope Caster (Unknown)
• Scope Effect (Unknown)
• Scope Missile (Unknown)
• Scope Outer (Unknown)
• Scope Source (Unknown)
• Scope Target (Unknown)

Hosting - Host For Properties - Subject

• Determines which actor this actor gets the properties for the Properties+ fields from
• If no actor is specified it defaults to the Hosting - Host - Subject actor

Hosting - Host Site Operations - Hold Position

• Locks the model in position according to the global 2D grid system but still allows for rotation relative to the host unit

Hosting - Host Site Operations - Hold Rotation

• Prevents the model turning relative to the host and locks it in the direction it was created in relative to the global 2D grid system while still allowing movement

Hosting - Host Site Operations - Operations

• This field is for applying all SOps that affect this actor
• Determines where it is attached, the offset, the rotation and alot more
• The order in the list is important with SOps being applied from top to bottom so an offset, offset and rotation is not the same as an offset, rotation and an offset
• For more details about SOps please look at the individual pages for each SOp

Hosting - Host Supporter - Actor

• Actor Find (Not Sure) means the actor has to be found using the scope
• Creation (Not Sure) is the actor that creates this actor is given priority for hosting if there is a choice of several
• Implicit is the default

Hosting - Host Supporter - Effect

• (Unknown)

Hosting - Host Supporter - Fail If No Host

• Causes the model to be automatically destroyed if no host

Hosting - Host Supporter - Scope

• Implicit is the default
• Scope Caster (Unknown)
• Scope Effect (Unknown)
• Scope Missile (Unknown)
• Scope Outer (Unknown)
• Scope Source (Unknown)
• Scope Target (Unknown)

Hosting - Host Supporter - Subject

• Actor refered to by the ::Supporter system reference for Events+

Hosting - Hosted Attachments - Attachment Query - Fallback (Unknown Function)

• Attachment point that is automatically selected if Hosting - Hosted Attachments - Attachment Query - Methods fails to find a valid attachment point
• Only actors that use these fields are tentacles

Hosting - Hosted Attachments - Attachment Query - Methods (Unknown Function)

• Attachment methods used or direct attachment reference for attaching
• Please refer to Attach Methods data type for more details
• With direct reference to an attachment point make sure you use the right index number (able to be seen in the previewer under Attachment Points)
• Only actors that use these fields are tentacles

Hosting - Hosted Attachments - Host - Actor (Unknown Function)

• Actor Find (Not Sure) means the actor has to be found using the scope
• Creation (Not Sure) is the actor that creates this actor is given priority for hosting if there is a choice of several
• Implicit is the default

Hosting - Hosted Attachments - Host - Effect (Unknown Function)

• (Unknown)

Hosting - Hosted Attachments - Host - Fail If No Host

• Causes the model to be automatically destroyed if no host

Hosting - Hosted Attachments - Host - Scope (Unknown Function)

• Implicit is the default
• Scope Caster (Unknown)
• Scope Effect (Unknown)
• Scope Missile (Unknown)
• Scope Outer (Unknown)
• Scope Source (Unknown)
• Scope Target (Unknown)

Hosting - Hosted Attachments - Host - Subject (Unknown Function)

• (Unknown)

Hosting - Hosted Attachments - Host Site Operations - Hold Position (Unknown Function)

• (Unknown)

Hosting - Hosted Attachments - Host Site Operations - Hold Rotation (Unknown Function)

• (Unknown)

Hosting - Hosted Attachments - Host Site Operations - Operations (Unknown Function)

• (Unknown)
• What is known is that SOps in these fields can cause the actor to fall off the host actor and remain detached in the position where this happens

Hosting - Hosted Attachments - Name (Unknown Function)

• (Unknown)
• Only actors that use these fields are tentacles

Properties - Accepted Property Transfers

When this actor is in the Hosting - Host - Subject field of another actor, this field determines what properties are able to be inherited from this actor

• Cast Shadows allows the attached actor to cast shadows
• Cloak Effect allows the attached actor to show the cloaking bluish effect
• Decal allows the attached actor to show the host unit decal
• Local Tint Color (Unknown)
• Model Scale makes the actor inherit the scale for the host model
• Opacity spreads the opacity set by the Set Opacity event to attached actors
• Physics State (Unknown)
• Scale transfers the scale of the host actor to the attached actors
• Team Color makes the attached actor show the team colour if it can
• Time Scale means the animations of the attached actor are the same as the host actors timescale
• Tint Color (Unknown)
• Visibility allows the attached actor to share the host actor's Actor - Fog Visibility
• Warp Group (Unknown)

Properties - Accepted Transfers

• Animation Properties (Unknown)
• Animator (Unknown)
• Fog Of War Color (Unknown)
• Fog Of War Shader (Unknown)
• Model (Unknown)
• Position (Unknown)
• Rotation (Unknown)
• Status (Unknown)
• Textures (Unknown)

Properties - Inherit Type

• Determines how often the host properties are inherited
• Continuous means the properties are continuously inherited from the host
• None means properties are not inherited from the host
• Once means properties are only inherited on actor creation

Properties - Inherited Properties

• This field determines what properties are able to be inherited from the actor in the Hosting - Host - Subject or Hosting - Host For Properties - Subject field
• Cast Shadows allows the attached actor to cast shadows
• Cloak Effect allows the attached actor to show the cloaking bluish effect
• Decal allows the attached actor to show the host unit decal
• Local Tint Color (Unknown)
• Model Scale makes the actor inherit the scale for the host model
• Opacity spreads the opacity set by the Set Opacity event to attached actors
• Physics State (Unknown)
• Scale transfers the scale of the host actor to the attached actors
• Team Color makes the attached actor show the team colour if it can
• Time Scale means the animations of the attached actor are the same as the host actors timescale
• Tint Color (Unknown)
• Visibility allows the attached actor to share the host actor's Actor - Fog Visibility
• Warp Group (Unknown)

Sound - Ability Sounds - Ability Command

• The abilities of the unit that you want to produce a sound when the button is clicked

Sound - Ability Sounds - Group Sound

• The sound played when a group units use the ability

Sound - Ability Sounds - Sound

• The sound played when the ability buttons are clicked

Sound - Group Sound Threshold

• (Unknown)

Sound - Group Sounds

• Sounds/voices produced by the unit when a group of the unit are highlighted/clicked/ordered
• Attack is the sound made when odered to attack a target or attack move
• Birth is the sound produced when the unit is created
• Board is the sound produced when loaded into a unit with the Transport ability
• Click (Unknown)
• Click Error (Unknown)
• Construction is the sound made if the unit is still under construction
• Highlight is the sound made when the unit is highlighted
• Movement is the sound made when moving
• Pissed is the sound made when the unit is clicked too often
• Ready (Unknown)
• Sound Help is the sound made when the unit calls for help
• Turning is the sound made when the unit is turning
• What is the sound made if clicked repeatedly
• Yes is the sound made when odered to move/cast an ability

Sound - Placement Sound

• The sound made when the unit is being placed

Sound - Sounds

• The sounds made by an individual unit when highlighted/clicked/ordered
• Attack is the sound made when odered to attack a target or attack move
• Birth is the sound produced when the unit is created
• Board is the sound produced when loaded into a unit with the Transport ability
• Click (Unknown)
• Click Error (Unknown)
• Construction is the sound made if the unit is still under construction
• Highlight is the sound made when the unit is highlighted
• Movement is the sound made when moving
• Pissed is the sound made when the unit is clicked too often
• Ready (Unknown)
• Sound Help is the sound made when the unit calls for help
• Turning is the sound made when the unit is turning
• What is the sound made if clicked repeatedly
• Yes is the sound made when odered to move/cast an ability

UI - Addon Indicator

• (Unknown) used by addons

UI - Bar Distance

• Sets the unit's bar distance relative to the camera
• Increasing the value makes the bar closer to the camera and appear bigger

UI - Bar Height

• The size of the bar in the y dimension

UI - Bar Offset

• How high above the unit the bar appears
• Scaled by UI - Bar Distance

UI - Bar Width

• The size of the bar in the x dimension

UI - Cooldown Display

• (Unknown)

UI - Errors - Error

• (Unknown)

UI - Errors - Group Sound

• The sound produced by a group of the unit when the error message occurs

UI - Errors - Sound

• The sound produced by the unit when the error message occurs

UI - Errors - Text

• (Unknown)

UI - Group Icon - Image

• The texture used to represent the unit when in a group

UI - Group Icon Variations - Image

• If the actor has variations like the dark templar this field can be used to have several different textures as variations for the group icon

UI - Group Icon Variations - Number

• Assigns the texture to a variation number

UI - Hero Icon

• If the unit has the Hero flag checked under the Unit - Flags of the unit then this is the texture shown for the hero at the lower right of the screen
• Seems to be broken since the recent patch

UI - Hero Icon Variations - Image

• If the actor has variations like the dark templar this field can be used to have several different textures as variations for the hero icon

UI - Hero Icon Variations - Number

• Assigns the texture to a variation number

UI - Highlight Tooltip

• The text shown when the unit is highlighted unless the Cannot Be Highlighted flag is checked under the Unit - Flags of the unit

UI - Info Text

• (Unknown)

UI - Life Armor Icon

• The texture used for the unit's life armor icon

UI - Minimap Icon

• The texture used for the unit on the minimap
• Only use for units that are not in a very high number

UI - Minimap Render Priority

• (Unknown)

UI - Name Offset

• (Unknown) seems to be larger value for most structures

UI - Select Ability Command

• (Unknown)

UI - Shield Armor Icon

• The texture used for the icon of the shield armor of the unit
• Default is the protoss shield icon
• This is commonly overlooked by map makers when making abilities that add shields to the unit

UI - Status Bar Flags

• The various bars that can be shown over the unit's head
• Cargo shows the white cargo bar if it has the Transport ability
• Duration shows the remaining duration of Buff behaviors if they have the UI - Display Countdown field set to show the duration
• Energy shows the proportion of the maximum energy it has if it has any energy at all
• Life shows the proportion of the maxiumum life the unit has
• Progress shows the progress bar for the unit when under construction if it has the Progress ability
• Shields shows the proportion of the maximum shields the unit has if it has any at all

UI - Status Bar Groups

• Determines who can see the status bar
• Can prevent people watching replays from seeing the bar

UI - Status Colors - Background Color

• Determines the colours of the borders and block seperations of the status bars

UI - Status Colors - Colors

• Determines the colours of the status bars
• For a status index the color begins at the highest number and decreases as the bar is emptied in equal amounts
• Different color numbers can have the same colour to make the colour change not appear linear eg. life
• The colours for the Life status affects the UI - Wireframe - Image

UI - Status Colors - Empty Color

• The colour of the various status bars when emptied
• Partially filled blocks will fade from the filled colour to the empty colour without mixing

UI - Unit Border Normal Color

• (Unknown)

UI - Unit Border Subgroup Color

• The colour of the borders of the unit UI - Group Icon - Image texture when multiple units are selected

UI - Unit Icon

• The texture displayed if the unit is assigned to a control group (Ctrl + 0-9)

UI - Unit Icon Variations - Image

• If the actor has variations like the dark templar this field can be used to have several different textures as variations for the unit icon

UI - Unit Icon Variations - Number

• Assigns the texture to a variation number

UI - Unit Kill Rank - Minimum Kills

• The number of kills needed to obtain each kill rank

UI - Unit Kill Rank - Text

• The text displayed for each rank
• Can be anything from Monstrosity to Adept

UI - Wireframe - Image

• The textures shown above the unit's life which adjusts colour with the UI - Status Colors - Colors
• Changes texture as the life bar depletes

UI - Wireframe Shield - Image

• The textures for the shield shown above the unit's life which adjusts colour with the UI - Status Colors - Colors
• Changes texture as the shield bar depletes

UI - Wireframe Shield Variations - Image

• If the actor has variations like the dark templar this field can be used to have several different textures as variations for the wireframe for the shield

UI - Wireframe Shield Variations - Number

• Assigns the texture to a variation number

UI - Wireframe Variations - Image

• If the actor has variations like the dark templar this field can be used to have several different textures as variations for the wireframe for the unit

UI - Wireframe Variations - Number

• Assigns the texture to a variation number

Unit - Unit Flags

• Show Blob Shadow (Unknown)
• Stand Animation Birth Variation (Unknown)
• Suppress Creation Errors (Unknown)
• Suppress Stand Intro (Unknown)
• Suppress Walk Intro (Unknown)
• Suppress Walk Outro (Unknown)

Related

• Actor events
• Models
• Sounds