sc2-gamedata
Public Attributes | List of all members
CAbilEffect Class Reference

Effect. More...

#include <Abil.h>

Inheritance diagram for CAbilEffect:
Inheritance graph
[legend]
Collaboration diagram for CAbilEffect:
Collaboration graph
[legend]

Public Attributes

CStringLink Activity
 Activity. More...
 
std::vector< CEffectLinkEffect
 Effect. More...
 
CFlags Flags
 Flags. More...
 
std::vector< SCostCost
 Cost. More...
 
std::vector< SCostCancelCost
 Cancel Cost. More...
 
CFlagArray< e_abilEffectStageCountRefundArray
 Refundable Stages. More...
 
SCostFactor RefundFraction
 Refund Fraction. More...
 
CUnitLink Placeholder
 Placeholder Unit. More...
 
std::vector< CTargetFiltersTargetFilters
 Target Filters. More...
 
STargetSorts TargetSorts
 Target Sorts. More...
 
std::vector< CFixedRange
 Range. More...
 
CFixed RangeSlop
 Range Extra. More...
 
CFangleArc Arc
 Arc. More...
 
CFangleArc ArcSlop
 Arc Slop. More...
 
CFangleArc TrackingArc
 Tracking Arc. More...
 
uint32 SmartPriority
 Smart Priority. More...
 
std::vector< CValidatorLinkSmartValidatorArray
 Smart Validators. More...
 
EAcquireLevel AutoCastAcquireLevel
 Auto Cast Acquire Level. More...
 
CTargetFilters AutoCastFilters
 Auto Cast Filters. More...
 
CFixed AutoCastRange
 Auto Cast Range. More...
 
std::vector< CValidatorLinkAutoCastValidatorArray
 Auto Cast Validators. More...
 
std::vector< CGameTimePrepTime
 Prepare Time. More...
 
std::vector< CGameTimeCastIntroTime
 Cast Start Time. More...
 
std::vector< CGameTimeCastOutroTime
 Cast Finish Time. More...
 
std::vector< CGameTimeFinishTime
 Finish Time. More...
 
SMarker Marker
 Marker. More...
 
CFlagArray< e_abilEffectStageCountUseMarkerArray
 Markers Used. More...
 
CFlagArray< e_abilEffectStageCountShowProgressArray
 Show Progress. More...
 
CFlagArray< e_abilEffectStageCountCancelableArray
 Cancelable. More...
 
CFlagArray< e_abilEffectStageCountPauseableArray
 Pauseable Stages. More...
 
CFlagArray< e_abilEffectStageCountPreemptableArray
 Preemptable Stages. More...
 
CFlagArray< e_abilEffectStageCountUninterruptibleArray
 Uninterruptible. More...
 
CFlagArray< e_abilEffectStageCountValidatedArray
 Validate. More...
 
CFlagArray< e_abilEffectStageCountInheritAttackPriorityArray
 Inherit Attack Priorities. More...
 
CAlertLink ErrorAlert
 Error Alert. More...
 
std::vector< CAlertLinkAlertArray
 Alert Array. More...
 
std::vector< CEffectLinkCursorEffect
 Cursor Effect. More...
 
CEffectLink CalldownEffect
 Calldown Effect. More...
 
CEffectLink AINotifyEffect
 AI Notify Effect. More...
 
std::vector< CUnitLinkProducedUnitArray
 Produced Unit. More...
 
std::vector< CButtonLinkProgressButtonArray
 Progress Buttons. More...
 
CCmdResult DefaultError
 Default Error. More...
 
std::vector< CImagePathLevelButtonImage
 Level Button - Image. More...
 
std::vector< CStringLinkLevelButtonName
 Level Button - Name. More...
 
std::vector< CStringLinkLevelButtonTooltip
 Level Button - Tooltip. More...
 
std::vector< CImagePathLevelButtonTooltipImage
 Level Button Tooltip Image. More...
 
std::vector< CfRangeEffectRange
 Effect Range. More...
 
std::vector< CImagePathLearnButtonImage
 Learn Button Image. More...
 
std::vector< CStringLinkLearnButtonName
 Learn Button Name. More...
 
std::vector< CStringLinkLearnButtonTooltip
 Learn Button Tooltip. More...
 
std::vector< CImagePathLearnButtonTooltipImage
 Learn Button Tooltip Image. More...
 
CTargetFilters IgnoreFilters
 Ignore Filters. More...
 

Detailed Description

Effect.

Remarks
Unknown

Member Data Documentation

◆ Activity

CStringLink CAbilEffect::Activity

Activity.

Determines the text displayed in the unit info panel while an order for this ability is active.

◆ AINotifyEffect

CEffectLink CAbilEffect::AINotifyEffect

AI Notify Effect.

◆ AlertArray

std::vector<CAlertLink> CAbilEffect::AlertArray

Alert Array.

Links to the alerts that will play at the different stages of the ability.

Remarks
indexEnum: EAbilEffectStage

◆ Arc

CFangleArc CAbilEffect::Arc

Arc.

Controls the arc around the caster that the target of the ability must be in. Example 360 is all around, 90 is a cone in front. If the target is outside this arc when the ability is cast, the caster will turn until the target is inside the arc.

Remarks
minValue: 0
maxValue: 0

◆ ArcSlop

CFangleArc CAbilEffect::ArcSlop

Arc Slop.

If the target is moving, how far past the initial arc are they allowed to move before casting is cancelled.

Remarks
minValue: 0
maxValue: 0

◆ AutoCastAcquireLevel

EAcquireLevel CAbilEffect::AutoCastAcquireLevel

Auto Cast Acquire Level.

◆ AutoCastFilters

CTargetFilters CAbilEffect::AutoCastFilters

Auto Cast Filters.

Auto Cast Target Filters

◆ AutoCastRange

CFixed CAbilEffect::AutoCastRange

Auto Cast Range.

The range at which auto casting can be triggered.

Remarks
minValue: 0
maxValue: 0

◆ AutoCastValidatorArray

std::vector<CValidatorLink> CAbilEffect::AutoCastValidatorArray

Auto Cast Validators.

The ability will only auto cast if the validators specified here all return true.

◆ CalldownEffect

CEffectLink CAbilEffect::CalldownEffect

Calldown Effect.

◆ CancelableArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::CancelableArray

Cancelable.

Stages at which the effect can be canceled

Remarks
indexEnum: EAbilEffectStage

◆ CancelCost

std::vector<SCost> CAbilEffect::CancelCost

Cancel Cost.

◆ CastIntroTime

std::vector<CGameTime> CAbilEffect::CastIntroTime

Cast Start Time.

The duration of the Cast phase

Remarks
minValue: 0

◆ CastOutroTime

std::vector<CGameTime> CAbilEffect::CastOutroTime

Cast Finish Time.

The minimum amount of time the casting unit must be in the Channel phase

Remarks
minValue: 0

◆ Cost

std::vector<SCost> CAbilEffect::Cost

Cost.

Cost parameters for the ability

◆ CursorEffect

std::vector<CEffectLink> CAbilEffect::CursorEffect

Cursor Effect.

To make an Area of Effect cursor display for this ability, hook up a Search Area effect to this field, and create a Splat actor that inherits from Cursor Splat.

◆ DefaultError

CCmdResult CAbilEffect::DefaultError

Default Error.

◆ Effect

std::vector<CEffectLink> CAbilEffect::Effect

Effect.

Selects the effect that will be applied. Specifying multiple effects here will let you choose an effect per level of this ability.

◆ EffectRange

std::vector<CfRange> CAbilEffect::EffectRange

Effect Range.

Remarks
minValue: 0,0
maxValue: 0,0

◆ ErrorAlert

CAlertLink CAbilEffect::ErrorAlert

Error Alert.

The Alert that will happen if the ability cannot be cast.

◆ FinishTime

std::vector<CGameTime> CAbilEffect::FinishTime

Finish Time.

The duration of the Finish stage, which occurs after the effect has been applied.

Remarks
minValue: 0

◆ Flags

CFlags CAbilEffect::Flags

Flags.

Flags for the ability.

Remarks
indexEnum: EAbilEffectFlag

◆ IgnoreFilters

CTargetFilters CAbilEffect::IgnoreFilters

Ignore Filters.

◆ InheritAttackPriorityArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::InheritAttackPriorityArray

Inherit Attack Priorities.

Remarks
indexEnum: EAbilEffectStage

◆ LearnButtonImage

std::vector<CImagePath> CAbilEffect::LearnButtonImage

Learn Button Image.

◆ LearnButtonName

std::vector<CStringLink> CAbilEffect::LearnButtonName

Learn Button Name.

◆ LearnButtonTooltip

std::vector<CStringLink> CAbilEffect::LearnButtonTooltip

Learn Button Tooltip.

◆ LearnButtonTooltipImage

std::vector<CImagePath> CAbilEffect::LearnButtonTooltipImage

Learn Button Tooltip Image.

◆ LevelButtonImage

std::vector<CImagePath> CAbilEffect::LevelButtonImage

Level Button - Image.

◆ LevelButtonName

std::vector<CStringLink> CAbilEffect::LevelButtonName

Level Button - Name.

◆ LevelButtonTooltip

std::vector<CStringLink> CAbilEffect::LevelButtonTooltip

Level Button - Tooltip.

◆ LevelButtonTooltipImage

std::vector<CImagePath> CAbilEffect::LevelButtonTooltipImage

Level Button Tooltip Image.

◆ Marker

SMarker CAbilEffect::Marker

Marker.

◆ PauseableArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::PauseableArray

Pauseable Stages.

Remarks
indexEnum: EAbilEffectStage

◆ Placeholder

CUnitLink CAbilEffect::Placeholder

Placeholder Unit.

Ghost placement image for the ability

◆ PreemptableArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::PreemptableArray

Preemptable Stages.

Remarks
indexEnum: EAbilEffectStage

◆ PrepTime

std::vector<CGameTime> CAbilEffect::PrepTime

Prepare Time.

Duration of the Prepare stage, which occurs in between Approach and Cast.

Remarks
minValue: 0

◆ ProducedUnitArray

std::vector<CUnitLink> CAbilEffect::ProducedUnitArray

Produced Unit.

◆ ProgressButtonArray

std::vector<CButtonLink> CAbilEffect::ProgressButtonArray

Progress Buttons.

An array of buttons that display at different stages of the ability.

Remarks
indexEnum: EAbilEffectStage

◆ Range

std::vector<CFixed> CAbilEffect::Range

Range.

Casting range of the ability

Remarks
minValue: 0
maxValue: 0

◆ RangeSlop

CFixed CAbilEffect::RangeSlop

Range Extra.

How much further a target unit may move away from the initial targeted position before casting is cancelled.

Remarks
minValue: 0
maxValue: 0

◆ RefundArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::RefundArray

Refundable Stages.

Remarks
indexEnum: EAbilEffectStage

◆ RefundFraction

SCostFactor CAbilEffect::RefundFraction

Refund Fraction.

The fraction of the costs that will be returned if the ability is cancelled.

◆ ShowProgressArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::ShowProgressArray

Show Progress.

The stages of the ability that a progress bar should appear for the caster.

Remarks
indexEnum: EAbilEffectStage

◆ SmartPriority

uint32 CAbilEffect::SmartPriority

Smart Priority.

Determines how important this ability is versus other abilities with a smart priority when deciding which ability should handle a smart command (usually bound to right click).

◆ SmartValidatorArray

std::vector<CValidatorLink> CAbilEffect::SmartValidatorArray

Smart Validators.

◆ TargetFilters

std::vector<CTargetFilters> CAbilEffect::TargetFilters

Target Filters.

Target unit types on which the ability can be used

◆ TargetSorts

STargetSorts CAbilEffect::TargetSorts

Target Sorts.

Determines how the ability prioritizes potential targets.

◆ TrackingArc

CFangleArc CAbilEffect::TrackingArc

Tracking Arc.

Remarks
minValue: 0
maxValue: 0

◆ UninterruptibleArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::UninterruptibleArray

Uninterruptible.

The stages at which the ability is uninterruptible.

Remarks
indexEnum: EAbilEffectStage

◆ UseMarkerArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::UseMarkerArray

Markers Used.

Remarks
indexEnum: EAbilEffectStage

◆ ValidatedArray

CFlagArray<e_abilEffectStageCount> CAbilEffect::ValidatedArray

Validate.

Remarks
indexEnum: EAbilEffectStage

The documentation for this class was generated from the following file: