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

Buff. More...

#include <Behavior.h>

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

Public Attributes

CFlags DisplayDuration
 Display Countdown. More...
 
CFlags DisplayShield
 Display Shield. More...
 
std::vector< CValidatorLinkDisableValidatorArray
 Validators (Disable) More...
 
std::vector< CValidatorLinkRemoveValidatorArray
 Validators (Remove) More...
 
CFlags BuffFlags
 Buff Flags. More...
 
uint32 MaxStackCount
 Maximum Stack Count. More...
 
uint32 MaxStackCountPerCaster
 Maximum Stack Count Per Caster. More...
 
SEffectWhichTimeScale TimeScaleSource
 Time Scale Source. More...
 
CGameTime Duration
 Duration. More...
 
CGameTime DurationShield
 Duration Shield. More...
 
std::vector< CGameTimeDurationVitalArray
 Duration Vital Bonuses. More...
 
std::vector< CGameTimeDurationVitalMaxArray
 Duration Vital Max Bonuses. More...
 
CGameTime DurationRandomMin
 Duration Random Maximum. More...
 
CGameTime DurationRandomMax
 Duration Random Minimum. More...
 
CGameTime DurationBonusMin
 Duration Bonus Minimum. More...
 
CGameTime DurationBonusMax
 Duration Bonus Maximum. More...
 
CGameTime Period
 Period. More...
 
uint32 PeriodCount
 Period Count. More...
 
CEffectLink InitialEffect
 Effect - Initial. More...
 
CEffectLink RefreshEffect
 Refresh Effect. More...
 
CEffectLink PeriodicEffect
 Effect - Periodic. More...
 
CEffectLink FinalEffect
 Effect - Final. More...
 
CEffectLink ExpireEffect
 Expire Effect. More...
 
SEffectWhichPlayer Player
 Player. More...
 
SEffectWhichPlayer AcquirePlayer
 Acquire Player. More...
 
SModification Modification
 Modification. More...
 
CEffectLink AINotifyEffect
 AI Notify Effect. More...
 
SDamageResponse DamageResponse
 Damage Response. More...
 
SEffectWhichUnit KillCredit
 Kill Credit. More...
 
EBehaviorBuffReplace Replace
 Replacement. More...
 
SEffectWhichLocation ReplaceLocation
 Replacement Location. More...
 
CHerdNodeLink HerdNode
 Herd Node. More...
 

Detailed Description

Buff.

Remarks
Unknown

Member Data Documentation

◆ AcquirePlayer

SEffectWhichPlayer CBehaviorBuff::AcquirePlayer

Acquire Player.

◆ AINotifyEffect

CEffectLink CBehaviorBuff::AINotifyEffect

AI Notify Effect.

◆ BuffFlags

CFlags CBehaviorBuff::BuffFlags

Buff Flags.

Flags specific to buff behaviors.

Remarks
indexEnum: EBehaviorBuff

◆ DamageResponse

SDamageResponse CBehaviorBuff::DamageResponse

Damage Response.

Parameters that control how this behavior responds to damage taken by the owning unit.

◆ DisableValidatorArray

std::vector<CValidatorLink> CBehaviorBuff::DisableValidatorArray

Validators (Disable)

If one of these validators returns false, the behavior will be disabled.

◆ DisplayDuration

CFlags CBehaviorBuff::DisplayDuration

Display Countdown.

Alignment of Players to which this behavior's countdown appears

Remarks
indexEnum: EBehaviorDisplay

◆ DisplayShield

CFlags CBehaviorBuff::DisplayShield

Display Shield.

Remarks
indexEnum: EBehaviorDisplay

◆ Duration

CGameTime CBehaviorBuff::Duration

Duration.

Duration of the behavior

◆ DurationBonusMax

CGameTime CBehaviorBuff::DurationBonusMax

Duration Bonus Maximum.

◆ DurationBonusMin

CGameTime CBehaviorBuff::DurationBonusMin

Duration Bonus Minimum.

◆ DurationRandomMax

CGameTime CBehaviorBuff::DurationRandomMax

Duration Random Minimum.

Each time this behavior is applied, a random value between the Duration Random Max and Duration Random Min will be chosen and added to the Duration.

◆ DurationRandomMin

CGameTime CBehaviorBuff::DurationRandomMin

Duration Random Maximum.

Each time this behavior is applied, a random value between the Duration Random Max and Duration Random Min will be chosen and added to the Duration.

◆ DurationShield

CGameTime CBehaviorBuff::DurationShield

Duration Shield.

◆ DurationVitalArray

std::vector<CGameTime> CBehaviorBuff::DurationVitalArray

Duration Vital Bonuses.

Remarks
indexEnum: EUnitVital

◆ DurationVitalMaxArray

std::vector<CGameTime> CBehaviorBuff::DurationVitalMaxArray

Duration Vital Max Bonuses.

Remarks
indexEnum: EUnitVital

◆ ExpireEffect

CEffectLink CBehaviorBuff::ExpireEffect

Expire Effect.

Effect that occurs if the behavior lasts through its entire duration.

◆ FinalEffect

CEffectLink CBehaviorBuff::FinalEffect

Effect - Final.

Effect that occurs when the behavior is removed.

◆ HerdNode

CHerdNodeLink CBehaviorBuff::HerdNode

Herd Node.

◆ InitialEffect

CEffectLink CBehaviorBuff::InitialEffect

Effect - Initial.

Effect that occurs when the behavior is applied.

◆ KillCredit

SEffectWhichUnit CBehaviorBuff::KillCredit

Kill Credit.

◆ MaxStackCount

uint32 CBehaviorBuff::MaxStackCount

Maximum Stack Count.

Maximum number of times the behavior can stack on a unit

Remarks
maxValue:

◆ MaxStackCountPerCaster

uint32 CBehaviorBuff::MaxStackCountPerCaster

Maximum Stack Count Per Caster.

Maximum number of times the behavior can stack on a unit per caster

◆ Modification

SModification CBehaviorBuff::Modification

Modification.

Modifications are a set of temporary changes applied to any unit that has this behavior.

◆ Period

CGameTime CBehaviorBuff::Period

Period.

Recurring interval that starts after the behavior is applied. The behavior will execute its Periodic Effect each interval.

◆ PeriodCount

uint32 CBehaviorBuff::PeriodCount

Period Count.

Maximum number of times the Periodic Effect can be executed. -1 means no limit.

◆ PeriodicEffect

CEffectLink CBehaviorBuff::PeriodicEffect

Effect - Periodic.

Effect that occurs each period.

◆ Player

SEffectWhichPlayer CBehaviorBuff::Player

Player.

Determines which player will own the unit that the behavior is applied to.

◆ RefreshEffect

CEffectLink CBehaviorBuff::RefreshEffect

Refresh Effect.

Effect that occurs when the behavior is reapplied

◆ RemoveValidatorArray

std::vector<CValidatorLink> CBehaviorBuff::RemoveValidatorArray

Validators (Remove)

If one of these validators returns false, the behavior will be removed.

◆ Replace

EBehaviorBuffReplace CBehaviorBuff::Replace

Replacement.

◆ ReplaceLocation

SEffectWhichLocation CBehaviorBuff::ReplaceLocation

Replacement Location.

◆ TimeScaleSource

SEffectWhichTimeScale CBehaviorBuff::TimeScaleSource

Time Scale Source.

Determines the scale applied to time values on this behavior. If set to global, will use the current global time scale. If set to Target or Caster, the behavior will use the timescale of the unit returned by that query.


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