Unit. More...
#include <Actor.h>
Detailed Description
Unit.
- Remarks
- Unknown
Member Data Documentation
◆ AbilSoundArray
| std::vector<SUnitAbilSound> CActorUnit::AbilSoundArray |
Ability Sounds.
Sounds for this unit that are associated with individual abilities.
◆ AddonIndicator
| CStringLink CActorUnit::AddonIndicator |
Addon Indicator.
◆ BarDistance
| uint32 CActorUnit::BarDistance |
Bar Distance.
◆ BarHeight
| int32 CActorUnit::BarHeight |
Bar Height.
The height of the unit's health bar.
- Remarks
- minValue: 1
- maxValue: 1
◆ BarOffset
| int32 CActorUnit::BarOffset |
Bar Offset.
How high above the attach point the health bar will appear.
- Remarks
- minValue: -800
- maxValue: -800
◆ BarWidth
| int32 CActorUnit::BarWidth |
Bar Width.
The width of the unit's health bar.
- Remarks
- minValue: 1
- maxValue: 1
◆ Baselines
| std::vector<SActorBaseline> CActorUnit::Baselines |
Baselines.
Baseline animations are animations that are always at the 'base' of the unit's animation stack.
- Remarks
- indexEnum: EActorBaselineType
◆ BuildModel
| CModelLink CActorUnit::BuildModel |
Model (Build)
Link to the asset the unit uses while under construction.
◆ CantSelectUncontrollableTooltip
| CStringLink CActorUnit::CantSelectUncontrollableTooltip |
Can't Select Uncontrollable Tooltip.
◆ CooldownDisplay
| std::vector<CAbilCommand> CActorUnit::CooldownDisplay |
Cooldown Display.
◆ CustomUnitStatusFrame
| CString CActorUnit::CustomUnitStatusFrame |
Custom Unit Status Frame.
◆ DeathActorModel
| CActorCreateKey CActorUnit::DeathActorModel |
Death Actor Model.
Link to the actor model that will be used for the unit's death.
◆ DeathActorModelLow
| CActorCreateKey CActorUnit::DeathActorModelLow |
Death Actor Model Low.
Link to the actor model that will be used for the unit's death when the player is on Low graphics settings.
◆ DeathActorSound
| CActorCreateKey CActorUnit::DeathActorSound |
Death Actor Sound.
Link to the actor sound that will be used for the unit's death.
◆ DeathActorVoice
| CActorCreateKey CActorUnit::DeathActorVoice |
Death Actor Voice.
Link to the actor sound that will be used for the unit's death voice.
◆ DeathArray
| std::vector<SActorDeathData> CActorUnit::DeathArray |
Death Effects.
Model and sound assets that the unit will use for different death types.
- Remarks
- indexEnum: EDeathType
◆ DeathCustomData
| std::vector<SActorDeathDataCustomGroup> CActorUnit::DeathCustomData |
Death Custom Data.
◆ DeathCustoms
| std::vector<SActorDeathDataCustom> CActorUnit::DeathCustoms |
Custom Death.
Custom deaths are used to have a unit play a atypical death models/animations in specific circumstances. To set up the circumstances for a custom death, use a Unit Death Customize event, set up the terms under which you want the death to occur, and send a
◆ EditorAnim
| CAnimProps CActorUnit::EditorAnim |
Editor Animation.
Animation the unit plays when viewed in the Terrain Editor.
◆ EditorModel
| CModelLink CActorUnit::EditorModel |
Model (Editor)
Model the unit uses when viewed in the Terrain Editor.
◆ ErrorArray
| std::vector<SErrorOverride> CActorUnit::ErrorArray |
Errors.
◆ GlossaryAnim
| CString CActorUnit::GlossaryAnim |
Glossary Animation.
Animation the unit plays when viewed in the in game unit glossary.
◆ GroupIcon
| SLayerIcon CActorUnit::GroupIcon |
Group Icon.
◆ GroupIconVariations
| std::vector<SLayerIconVariation> CActorUnit::GroupIconVariations |
Group Icon Variations.
◆ GroupSoundArray
| std::vector<CSoundLink> CActorUnit::GroupSoundArray |
Group Sounds.
The sound the unit will play when it is selected in a group.
- Remarks
- indexEnum: EUnitSound
◆ GroupSoundThreshold
| uint32 CActorUnit::GroupSoundThreshold |
Group Sound Threshold.
◆ HeroIcon
| CImagePath CActorUnit::HeroIcon |
Hero Icon.
The icon displayed in the hero icon area of the game UI if this unit is flagged as being a hero.
◆ HeroIconVariations
| std::vector<SIconVariation> CActorUnit::HeroIconVariations |
Hero Icon Variations.
◆ HighlightSubTooltip
| CStringLink CActorUnit::HighlightSubTooltip |
Highlight Sub Tooltip.
◆ HighlightTooltip
| CStringLink CActorUnit::HighlightTooltip |
Highlight Tooltip.
◆ InfoText
| CStringLink CActorUnit::InfoText |
Info Text.
◆ LifeArmorIcon
| CImagePath CActorUnit::LifeArmorIcon |
Life Armor Icon.
The icon for this unit's armor type.
◆ MinimapFlashWhenAttacked
| flag8 CActorUnit::MinimapFlashWhenAttacked |
Minimap Flash When Attacked.
◆ MinimapIcon
| CImagePath CActorUnit::MinimapIcon |
Minimap Icon.
The icon for this unit on the minimap.
◆ MinimapIconBackground
| CImagePath CActorUnit::MinimapIconBackground |
Minimap Icon Background.
◆ MinimapIconBackgroundIsTeamColored
| flag8 CActorUnit::MinimapIconBackgroundIsTeamColored |
Minimap Icon Background Is Team Colored.
◆ MinimapIconBackgroundScale
| real32 CActorUnit::MinimapIconBackgroundScale |
Minimap Icon Background Scale.
◆ MinimapIconIsTeamColored
| flag8 CActorUnit::MinimapIconIsTeamColored |
Minimap Icon Is Team Colored.
◆ MinimapIconScale
| real32 CActorUnit::MinimapIconScale |
Minimap Icon Scale.
◆ MinimapRenderPriority
| CActorKey CActorUnit::MinimapRenderPriority |
Minimap Render Priority.
◆ MinimapTooltip
| CStringLink CActorUnit::MinimapTooltip |
Minimap Tooltip.
◆ MinimapUseSelectionColor
| flag8 CActorUnit::MinimapUseSelectionColor |
Minimap Use Selection Color.
◆ MinimapUseSelfColor
| flag8 CActorUnit::MinimapUseSelfColor |
Minimap Use Self Color.
◆ MovementHerdNode
| CHerdNodeLink CActorUnit::MovementHerdNode |
Movement Herd Node.
◆ NameOffset
| int32 CActorUnit::NameOffset |
Name Offset.
- Remarks
- minValue: -800
- maxValue: -800
◆ OverkillByDamageOverInterval
| SDamageOverInterval CActorUnit::OverkillByDamageOverInterval |
Overkill By Damage Over Interval.
◆ OverkillByDamagePastRemainingHealth
| SDamagePastRemainingHealth CActorUnit::OverkillByDamagePastRemainingHealth |
Overkill By Damage Past Remaining Health.
◆ PhysicsMatchKeysOrdered
| CActorTableKeys1x3 CActorUnit::PhysicsMatchKeysOrdered |
Physics Match Keys Ordered.
◆ PlaceholderActorModel
| CActorCreateKey CActorUnit::PlaceholderActorModel |
Placeholder Actor Model.
◆ PlacementActorModel
| CActorCreateKey CActorUnit::PlacementActorModel |
Placement Model.
◆ PlacementModel
| CModelLink CActorUnit::PlacementModel |
Model (Placement)
Link to the asset the unit uses while being placed.
◆ PlacementSound
| CSoundLink CActorUnit::PlacementSound |
Placement Sound.
Link to the asset the unit plays when it is placed.
◆ PortraitActor
| CActorCreateKey CActorUnit::PortraitActor |
Portrait Actor.
Link to the actor portrait this unit's portrait will use.
◆ PortraitCamera
| CCameraLink CActorUnit::PortraitCamera |
Portrait Camera.
◆ PortraitModel
| CModelLink CActorUnit::PortraitModel |
Model (Portrait)
Link to the asset this unit's portrait uses.
◆ RandomScaleRange
| CRange CActorUnit::RandomScaleRange |
Random Scale Range.
◆ SelectAbilCmd
| CAbilCommand CActorUnit::SelectAbilCmd |
Select Ability Command.
◆ ShieldArmorIcon
| CImagePath CActorUnit::ShieldArmorIcon |
Shield Armor Icon.
The icon for this unit's shield type.
◆ SnapshotActor
| CActorCreateKey CActorUnit::SnapshotActor |
Snapshot Actor.
◆ SoundArray
| std::vector<CSoundLink> CActorUnit::SoundArray |
◆ StandAnimTurnTime
| CGameTime CActorUnit::StandAnimTurnTime |
Animation Turn Duration.
- Remarks
- minValue: 0
◆ StandAnimTurnTimeScaleMin
| real32 CActorUnit::StandAnimTurnTimeScaleMin |
Stand Animation Turn Time Scale Minimum.
- Remarks
- minValue: 0
◆ StatusBarFlags
| CFlagArray<e_unitStatusCount> CActorUnit::StatusBarFlags |
Status Bar Flags.
The status bars that are allowed to appear on the unit.
- Remarks
- indexEnum: EUnitStatus
◆ StatusBarGroups
| CFlagArray<e_unitStatusGroupCount> CActorUnit::StatusBarGroups |
Status Bar Groups.
- Remarks
- indexEnum: EUnitStatusGroup
◆ StatusBarOn
| CFlagArray<e_unitStatusCount> CActorUnit::StatusBarOn |
Status Bar Forced On.
- Remarks
- indexEnum: EUnitStatus
◆ StatusColors
| std::vector<SStatusColor> CActorUnit::StatusColors |
Status Colors.
The color properties of the various status bar types for this unit.
- Remarks
- indexEnum: EUnitStatus
◆ StatusHarvesterData
| SStatusHarvesterData CActorUnit::StatusHarvesterData |
Status Harvester Data.
◆ StatusTextInfo
| STextTagParameters CActorUnit::StatusTextInfo |
Status Text Info.
◆ TerrainSquibs
| std::vector<STerrainSquib> CActorUnit::TerrainSquibs |
Terrain Squibs.
◆ UnitBorderNormalColor
| CColorRGB CActorUnit::UnitBorderNormalColor |
Unit Border Normal Color.
◆ UnitBorderSubgroupColor
| CColorRGB CActorUnit::UnitBorderSubgroupColor |
Unit Border Subgroup Color.
◆ UnitFlags
| CFlags CActorUnit::UnitFlags |
Unit Flags.
- Remarks
- indexEnum: EActorUnitFlag
◆ UnitIcon
| CImagePath CActorUnit::UnitIcon |
Unit Icon.
The icon that will display in the control group bar if this unit is assigned to a control group.
◆ UnitIconVariations
| std::vector<SIconVariation> CActorUnit::UnitIconVariations |
Unit Icon Variations.
◆ UnitKillRank
| std::vector<SUnitKillRank> CActorUnit::UnitKillRank |
Unit Kill Rank.
◆ UnitModelFrameActor
| CActorCreateKey CActorUnit::UnitModelFrameActor |
Unit Model Frame Actor.
◆ VarianceWindowStand
| real32 CActorUnit::VarianceWindowStand |
Variance Window Stand.
- Remarks
- minValue: 0
- maxValue: 0
◆ VarianceWindowStandIntro
| real32 CActorUnit::VarianceWindowStandIntro |
Variance Window Stand Intro.
- Remarks
- minValue: 0
- maxValue: 0
◆ VarianceWindowWalk
| real32 CActorUnit::VarianceWindowWalk |
Variance Window Walk.
- Remarks
- minValue: 0
- maxValue: 0
◆ VarianceWindowWalkIntro
| real32 CActorUnit::VarianceWindowWalkIntro |
Variance Window Walk Intro.
- Remarks
- minValue: 0
- maxValue: 0
◆ VarianceWindowWalkOutro
| real32 CActorUnit::VarianceWindowWalkOutro |
Variance Window Walk Outro.
- Remarks
- minValue: 0
- maxValue: 0
◆ VitalColors
| std::vector<SVitalColor> CActorUnit::VitalColors |
Vital Colors.
- Remarks
- indexEnum: EVitalColor
◆ VitalNames
| std::vector<CStringLink> CActorUnit::VitalNames |
Vital Names.
- Remarks
- indexEnum: EVitalColor
◆ WalkAnimMoveSpeed
| CGameRate CActorUnit::WalkAnimMoveSpeed |
Walk Animation Movement Speed.
The number of game units per second that the walk animation is animated to, so that the unit's model doesn't get 'slippy feet' visual artifacts. A WalkAnimMoveSpeed of 3 means the unit is animated to walk at a rate of 3 tiles per second in the default case. (The artist creating the asset actually types a value that is 100 times this into the asset in MAX, because in that context, a tile is 100 inches.)
- Remarks
- minValue: 0
◆ WalkAnimTimeScalingAsFlyer
| flag8 CActorUnit::WalkAnimTimeScalingAsFlyer |
Walk Animation Time Scaling As Flyer.
Enables a ground unit to avoid time scaling its walk animations, as if it was a flyer. Normally, ground units automatically modify their walk animation time scale as they accelerate and decelerate, to ensure their feet do not appear to slide on the ground. Flyers do not need this time scaling, because they do not have feet that need to be matched to the ground. However, a ground unit like a hovercraft does not need this time scaling either, because it also does not have feet and appears to hover over the ground like a flyer. In short, this flag exists to handle the hovercraft scenario.
◆ Wireframe
| SLayerIcon CActorUnit::Wireframe |
Wireframe.
◆ WireframeShield
| SLayerIconShield CActorUnit::WireframeShield |
Wireframe Shield.
◆ WireframeShieldColor
| CColor CActorUnit::WireframeShieldColor |
Wireframe Shield Color.
◆ WireframeShieldVariations
| std::vector<SLayerIconShieldVariation> CActorUnit::WireframeShieldVariations |
Wireframe Shield Variations.
◆ WireframeVariations
| std::vector<SLayerIconVariation> CActorUnit::WireframeVariations |
Wireframe Variations.
The documentation for this class was generated from the following file:
