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

Create Persistent. More...

#include <Effect.h>

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

Public Attributes

SEffectWhichLocation WhichLocation
 Location. More...
 
SEffectWhichTimeScale TimeScaleSource
 Time Scale Source. More...
 
SEffectWhichLocation OffsetVectorStartLocation
 Location Offset - Start. More...
 
SEffectWhichLocation OffsetVectorEndLocation
 Location Offset - End. More...
 
SEffectWhichLocation OffsetFacingFallback
 Offset Facing Fallback. More...
 
CFlags Flags
 Flags. More...
 
CGameTime InitialDelay
 Initial Delay. More...
 
CEffectLink InitialEffect
 Effect - Initial. More...
 
CEffectOffset InitialOffset
 Offset - Initial. More...
 
CGameTime ExpireDelay
 Expire Delay. More...
 
CEffectLink ExpireEffect
 Effect - Expire. More...
 
CEffectOffset ExpireOffset
 Offset - Expire. More...
 
CEffectLink FinalEffect
 Effect - Final. More...
 
CEffectOffset FinalOffset
 Offset - Final. More...
 
uint32 PeriodCount
 Period Count. More...
 
CValidatorLink PeriodicValidator
 Periodic Validator. More...
 
std::vector< CEffectLinkPeriodicEffectArray
 Period Effects. More...
 
std::vector< CEffectOffsetPeriodicOffsetArray
 Periodic Offsets. More...
 
std::vector< CGameTimePeriodicPeriodArray
 Period Durations. More...
 
CFixed RevealRadius
 Reveal Radius. More...
 
CFlagArray< e_effectRevealFlagCountRevealFlags
 Reveal Flags. More...
 
CTargetFilters DetectFilters
 Detect Filters. More...
 
CTargetFilters RadarFilters
 Radar Filters. More...
 
EHeightMap HeightMap
 Height Map. More...
 
CEffectLink AINotifyEffect
 AI Notify Effect. More...
 

Detailed Description

Create Persistent.

Remarks
Unknown

Member Data Documentation

◆ AINotifyEffect

CEffectLink CEffectCreatePersistent::AINotifyEffect

AI Notify Effect.

This can be used to alert the AI of an area of effect to help it avoid hostile areas and prefer friendly areas.

◆ DetectFilters

CTargetFilters CEffectCreatePersistent::DetectFilters

Detect Filters.

If the Reveal Radius for this effect is non-zero then this field configures what units are detected.

◆ ExpireDelay

CGameTime CEffectCreatePersistent::ExpireDelay

Expire Delay.

Delay that occurs after the periodic durations

◆ ExpireEffect

CEffectLink CEffectCreatePersistent::ExpireEffect

Effect - Expire.

Effect that runs if the persistent effect expires

◆ ExpireOffset

CEffectOffset CEffectCreatePersistent::ExpireOffset

Offset - Expire.

Offset coordinates for the Expire Effect

◆ FinalEffect

CEffectLink CEffectCreatePersistent::FinalEffect

Effect - Final.

Effect that runs when the persistent effect is destroyed, regardless of whether it expired or not

◆ FinalOffset

CEffectOffset CEffectCreatePersistent::FinalOffset

Offset - Final.

Offset coordinates for the Final Effect

◆ Flags

CFlags CEffectCreatePersistent::Flags

Flags.

Flags for the effect

Remarks
indexEnum: ECreatePersistent

◆ HeightMap

EHeightMap CEffectCreatePersistent::HeightMap

Height Map.

If the Reveal Radius for this effect is non-zero then this field configures what height map the reveal occurs on. If the reveal happens on the air height map then line of sight is ignored.

◆ InitialDelay

CGameTime CEffectCreatePersistent::InitialDelay

Initial Delay.

Delay that occurs when the effect is created.

◆ InitialEffect

CEffectLink CEffectCreatePersistent::InitialEffect

Effect - Initial.

Effect that runs after the Initial Delay

◆ InitialOffset

CEffectOffset CEffectCreatePersistent::InitialOffset

Offset - Initial.

Offset coordinates for the Initial Effect

◆ OffsetFacingFallback

SEffectWhichLocation CEffectCreatePersistent::OffsetFacingFallback

Offset Facing Fallback.

Specifies a fallback unit to use when calculating the offset of spawned effects relative to the start and end offset vectors if one or both of them is invalid.

◆ OffsetVectorEndLocation

SEffectWhichLocation CEffectCreatePersistent::OffsetVectorEndLocation

Location Offset - End.

Used in conjunction with the Offset Vector Start Location to configure a direction that child effects will “travel” as they are executed. The End location is the farthest location from the Start location that the effects will go.

◆ OffsetVectorStartLocation

SEffectWhichLocation CEffectCreatePersistent::OffsetVectorStartLocation

Location Offset - Start.

Used in conjunction with the Offset Vector End Location to configure a direction that child effects will “travel” as they are executed. The Start location is usually either the caster or target location depending on what makes sense for the ability using this effect.

◆ PeriodCount

uint32 CEffectCreatePersistent::PeriodCount

Period Count.

Number of periods

Remarks
maxValue:

◆ PeriodicEffectArray

std::vector<CEffectLink> CEffectCreatePersistent::PeriodicEffectArray

Period Effects.

Effects that will run when a period ends

◆ PeriodicOffsetArray

std::vector<CEffectOffset> CEffectCreatePersistent::PeriodicOffsetArray

Periodic Offsets.

Offset coordinates for the periodic effects

◆ PeriodicPeriodArray

std::vector<CGameTime> CEffectCreatePersistent::PeriodicPeriodArray

Period Durations.

Specifies the length of time between executing each periodic effect. Effects with a period count that exceeds the number of entries in this array will loop back and repeat the entries in order until the period count has been reached.

◆ PeriodicValidator

CValidatorLink CEffectCreatePersistent::PeriodicValidator

Periodic Validator.

Validator that will be checked periodically. If this validator fails, the persistent effect will be destroyed.

◆ RadarFilters

CTargetFilters CEffectCreatePersistent::RadarFilters

Radar Filters.

If the Reveal Radius for this effect is non-zero then this field configures what units appear as radar blips under the fog of war.

◆ RevealFlags

CFlagArray<e_effectRevealFlagCount> CEffectCreatePersistent::RevealFlags

Reveal Flags.

Flags that determine how the effect area is revealed for the casting player

Remarks
indexEnum: EEffectRevealFlag

◆ RevealRadius

CFixed CEffectCreatePersistent::RevealRadius

Reveal Radius.

Radius of the effect area that is revealed

Remarks
minValue: 0
maxValue: 0

◆ TimeScaleSource

SEffectWhichTimeScale CEffectCreatePersistent::TimeScaleSource

Time Scale Source.

Specifies the unit to use to track the progress of time while the effect updates.

◆ WhichLocation

SEffectWhichLocation CEffectCreatePersistent::WhichLocation

Location.

Location where the effect occurs


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