Effect.h File Reference

#include "UnderlyingTypes.h"
#include "Game.h"
#include "Behavior.h"
#include "TargetSort.h"

Include dependency graph for Effect.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SEffectArea
struct	SEffectDamageArea
struct	SEffectEnumArea
struct	SEffectModifyPlayerCost
struct	SEffectModifyUnitCost
struct	SEffectModifyVital
struct	SEffectSwitchCase
struct	SEffectMover
class	CEffect
	Generic. More...
class	CEffectResponse
	Response. More...
class	CEffectApplyBehavior
	Apply Behavior. More...
class	CEffectApplyForce
	Apply Force. More...
class	CEffectCancelOrder
	Cancel Order. More...
class	CEffectCreateHealer
	Create Healer. More...
class	CEffectCreatePersistent
	Create Persistent. More...
class	CEffectCreateUnit
	Create Unit. More...
class	CEffectDamage
	Damage. More...
class	CEffectDestroyHealer
	Destroy Healer. More...
class	CEffectDestroyPersistent
	Destroy Persistent. More...
class	CEffectEnumArea
	Search Area. More...
class	CEffectEnumMagazine
	Iterate Magazine. More...
class	CEffectEnumTransport
	Iterate Transport. More...
class	CEffectIssueOrder
	Issue Order. More...
class	CEffectLaunchMissile
	Launch Missile. More...
class	CEffectModifyPlayer
	Modify Player. More...
class	CEffectModifyUnit
	Modify Unit. More...
class	CEffectRedirectMissile
	Redirect Missile. More...
class	CEffectReleaseMagazine
	Release Magazine. More...
class	CEffectRemoveBehavior
	Remove Behavior. More...
class	CEffectReturnMagazine
	Return Magazine. More...
class	CEffectSet
	Set. More...
class	CEffectSwitch
	Switch. More...
class	CEffectTeleport
	Teleport. More...
class	CEffectTransferBehavior
	Transfer Behavior. More...
class	CEffectUseCalldown
	Use Calldown. More...
class	CEffectUseMagazine
	Use Magazine. More...

Enumerations
enum	EClassIdCEffect {   e_classIdCEffect, e_classIdCEffectResponse, e_classIdCEffectApplyBehavior, e_classIdCEffectApplyForce,   e_classIdCEffectCancelOrder, e_classIdCEffectCreateHealer, e_classIdCEffectCreatePersistent, e_classIdCEffectCreateUnit,   e_classIdCEffectDamage, e_classIdCEffectDestroyHealer, e_classIdCEffectDestroyPersistent, e_classIdCEffectEnumArea,   e_classIdCEffectEnumMagazine, e_classIdCEffectEnumTransport, e_classIdCEffectIssueOrder, e_classIdCEffectLaunchMissile,   e_classIdCEffectModifyPlayer, e_classIdCEffectModifyUnit, e_classIdCEffectRedirectMissile, e_classIdCEffectReleaseMagazine,   e_classIdCEffectRemoveBehavior, e_classIdCEffectReturnMagazine, e_classIdCEffectSet, e_classIdCEffectSwitch,   e_classIdCEffectTeleport, e_classIdCEffectTransferBehavior, e_classIdCEffectUseCalldown, e_classIdCEffectUseMagazine }
	Effect Type. More...
enum	EEffectRevealFlag {   e_effectRevealFlagUnfog, e_effectRevealFlagDetect, e_effectRevealFlagRadar, e_effectRevealFlagLoS,   e_effectRevealFlagPermanent }
	Reveal Flag. More...
enum	EEffectCombine { e_effectCombineAnd, e_effectCombineOr }
	Effect Combine. More...
enum	EEffectApplyBehaviorFlag { e_effectApplyBehaviorFlagUseDuration }
	Apply Behavior Flag. More...
enum	EEffectCancelOrderFlag { e_effectCancelOrderFlagActive, e_effectCancelOrderFlagQueued, e_effectCancelOrderFlagUninterruptible }
	Cancel Order Flag. More...
enum	ECreatePersistent {   e_createPersistentChanneled, e_createPersistentChanneling, e_createPersistentEffectSuccess, e_createPersistentEffectFailure,   e_createPersistentOrphanParams, e_createPersistentRandomEffect, e_createPersistentRandomOffset, e_createPersistentRandomPeriod,   e_createPersistentPersistUntilDestroyed }
	Create Persistent Type. More...
enum	ECreateUnit {   e_createUnitBirth, e_createUnitDropOff, e_createUnitOffsetByRadius, e_createUnitPlacement,   e_createUnitPlacementIgnoreBlockers, e_createUnitPlacementIgnoreCliffTest, e_createUnitPrecursor, e_createUnitProvideFood,   e_createUnitSetFacing, e_createUnitSelectControlGroups, e_createUnitTechComplete, e_createUnitUseFood }
	Unit Creation Options. More...
enum	EDamageVisibility { e_damageVisibilityHidden, e_damageVisibilitySnapshot, e_damageVisibilityVisible }
	Damage Visibility. More...
enum	EDamageFlag {   e_damageFlagLive, e_damageFlagKill, e_damageFlagNotification, e_damageFlagNoKillCredit,   e_damageFlagNoLeech, e_damageFlagNoGain, e_damageFlagNoScaledDealtBonus, e_damageFlagNoFractionDealtBonus,   e_damageFlagNoUnscaledDealtBonus, e_damageFlagNoDealtMaximum, e_damageFlagNoDealtMinimum, e_damageFlagNoBehaviorResponse,   e_damageFlagNoVitalAbsorbLife, e_damageFlagNoVitalAbsorbShields, e_damageFlagNoVitalAbsorbEnergy, e_damageFlagNoVitalLeechLife,   e_damageFlagNoVitalLeechShields, e_damageFlagNoVitalLeechEnergy, e_damageFlagNoVitalGainLife, e_damageFlagNoVitalGainShields,   e_damageFlagNoVitalGainEnergy }
	Damage Flag. More...
enum	EDamageSound { e_damageSoundLaunch, e_damageSoundImpact }
	Damage Sound. More...
enum	EDamageTotal { e_damageTotalMaximum, e_damageTotalMinimum, e_damageTotalCombine }
	Damage Total. More...
enum	EEffectHealerFlag { e_effectHealerFlagChanneled, e_effectHealerFlagChanneling }
	Healer Flag. More...
enum	EEffectMissile {   e_effectMissile2D, e_effectMissileChanneled, e_effectMissilePlacement, e_effectMissilePlacementIgnoreBlockers,   e_effectMissilePlacementIgnoreCliffTest, e_effectMissilePointFallback, e_effectMissileRetarget, e_effectMissileReturn,   e_effectMissileTransfer, e_effectMissileTravelValidation, e_effectMissileValidateAbil, e_effectMissileValidateWeapon }
	Missile. More...
enum	EMoverPatternType { e_moverPatternTypeStripe, e_moverPatternTypeBounce }
	Mover Pattern Type. More...
enum	EEffectModify {   e_effectModifyCopy, e_effectModifyOwner, e_effectModifyHide, e_effectModifyShow,   e_effectModifyMimic, e_effectModifyNullifyMissile, e_effectModifySalvage, e_effectModifyCopyAutoCast }
	Modification Flag. More...
enum	EEffectTeleport { e_effectTeleportTestCliff, e_effectTeleportTestFog, e_effectTeleportTestZone }
	Effect Teleport. More...
enum	EResponseFlag { e_responseFlagAcquire, e_responseFlagFlee }
	Response Flag. More...
enum	ENotifyAreaFlag {   e_notifyAreaFlagHelpFriend, e_notifyAreaFlagHurtFriend, e_notifyAreaFlagHurtEnemy, e_notifyAreaFlagOnlyWorkers,   e_notifyAreaFlagMinorDanger }
	Notify Area Flag. More...
enum	EEffectRedirectMissile { e_effectRedirectMissileOriginalValidation }
	Effect Redirect Missile. More...

Variables
const int32	e_classIdCEffectCount = 28
const int32	e_effectRevealFlagCount = 5
const int32	e_effectCombineCount = 2
const int32	e_effectApplyBehaviorFlagCount = 1
const int32	e_effectCancelOrderFlagCount = 3
const int32	e_createPersistentCount = 9
const int32	e_createUnitCount = 12
const int32	e_damageVisibilityCount = 3
const int32	e_damageFlagCount = 21
const int32	e_damageSoundCount = 2
const int32	e_damageTotalCount = 3
const int32	e_effectHealerFlagCount = 2
const int32	e_effectMissileCount = 12
const int32	e_moverPatternTypeCount = 2
const int32	e_effectModifyCount = 8
const int32	e_effectTeleportCount = 3
const int32	e_responseFlagCount = 2
const int32	e_notifyAreaFlagCount = 5
const int32	e_effectRedirectMissileCount = 1

Enumeration Type Documentation

EClassIdCEffect

enum EClassIdCEffect

Effect Type.

Remarks

Unknown

Enumerator
e_classIdCEffect	Generic.
e_classIdCEffectResponse	Response.
e_classIdCEffectApplyBehavior	Apply Behavior.
e_classIdCEffectApplyForce	Apply Force.
e_classIdCEffectCancelOrder	Cancel Order.
e_classIdCEffectCreateHealer	Create Healer.
e_classIdCEffectCreatePersistent	Create Persistent.
e_classIdCEffectCreateUnit	Create Unit.
e_classIdCEffectDamage	Effect Damage.
e_classIdCEffectDestroyHealer	Destroy Healer.
e_classIdCEffectDestroyPersistent	Destroy Persistent.
e_classIdCEffectEnumArea	Search Area.
e_classIdCEffectEnumMagazine	Enum Magazine.
e_classIdCEffectEnumTransport	Iterate Transport.
e_classIdCEffectIssueOrder	Issue Order.
e_classIdCEffectLaunchMissile	Launch Missile.
e_classIdCEffectModifyPlayer	Modify Player.
e_classIdCEffectModifyUnit	Modify Unit.
e_classIdCEffectRedirectMissile	Redirect Missile.
e_classIdCEffectReleaseMagazine	Release Magazine.
e_classIdCEffectRemoveBehavior	Remove Behavior.
e_classIdCEffectReturnMagazine	Return Magazine.
e_classIdCEffectSet	Set.
e_classIdCEffectSwitch	Switch.
e_classIdCEffectTeleport	Teleport.
e_classIdCEffectTransferBehavior	Transfer Behavior.
e_classIdCEffectUseCalldown	Use Calldown.
e_classIdCEffectUseMagazine	Use Magazine.

ECreatePersistent

enum ECreatePersistent

Create Persistent Type.

Remarks

Unknown

Enumerator
e_createPersistentChanneled	Channeled.
e_createPersistentChanneling	Channeling.
e_createPersistentEffectSuccess	Success.
e_createPersistentEffectFailure	Failure.
e_createPersistentOrphanParams	Orphan Parameters.
e_createPersistentRandomEffect	Random Effect.
e_createPersistentRandomOffset	Random Offset.
e_createPersistentRandomPeriod	Random Period.
e_createPersistentPersistUntilDestroyed	Persist Until Destroyed. When this flag is enabled, the Period Count will be ignored, and the effect will persist until either the periodic validator fails, or the effect is destroyed.

ECreateUnit

enum ECreateUnit

Unit Creation Options.

Remarks

Unknown

Enumerator
e_createUnitBirth	Birth.
e_createUnitDropOff	Drop Off.
e_createUnitOffsetByRadius	Offset By Radius.
e_createUnitPlacement	Placement.
e_createUnitPlacementIgnoreBlockers	Ignore Blockers.
e_createUnitPlacementIgnoreCliffTest	Ignore Cliff Test.
e_createUnitPrecursor	Precursor.
e_createUnitProvideFood	Provides Food.
e_createUnitSetFacing	Set Facing.
e_createUnitSelectControlGroups	Select Control Groups.
e_createUnitTechComplete	Provide Complete Tech.
e_createUnitUseFood	Uses Food.

EDamageFlag

enum EDamageFlag

Damage Flag.

Remarks

Unknown

Enumerator
e_damageFlagLive	Live.
e_damageFlagKill	Kill.
e_damageFlagNotification	Notification.
e_damageFlagNoKillCredit	No Kill Credit.
e_damageFlagNoLeech	No Leech.
e_damageFlagNoGain	No Gain.
e_damageFlagNoScaledDealtBonus	No Dealt Bonus (Scaled)
e_damageFlagNoFractionDealtBonus	No Dealt Bonus (Fraction)
e_damageFlagNoUnscaledDealtBonus	No Dealt Bonus (Unscaled)
e_damageFlagNoDealtMaximum	No Dealt Maximum.
e_damageFlagNoDealtMinimum	No Dealt Minimum.
e_damageFlagNoBehaviorResponse	No Behavior Response.
e_damageFlagNoVitalAbsorbLife	No Absorb Life.
e_damageFlagNoVitalAbsorbShields	No Absorb Shields.
e_damageFlagNoVitalAbsorbEnergy	No Absorb Energy.
e_damageFlagNoVitalLeechLife	No Leech Life.
e_damageFlagNoVitalLeechShields	No Leech Shields.
e_damageFlagNoVitalLeechEnergy	No Leech Energy.
e_damageFlagNoVitalGainLife	No Gain Life.
e_damageFlagNoVitalGainShields	No Gain Shields.
e_damageFlagNoVitalGainEnergy	No Gain Energy.

EDamageSound

enum EDamageSound

Damage Sound.

Remarks

Unknown

Enumerator
e_damageSoundLaunch	Launch.
e_damageSoundImpact	Impact.

EDamageTotal

enum EDamageTotal

Damage Total.

Remarks

Enum

Enumerator
e_damageTotalMaximum	Maximum.
e_damageTotalMinimum	Minimum.
e_damageTotalCombine	Combine.

EDamageVisibility

enum EDamageVisibility

Damage Visibility.

Remarks

Enum

Enumerator
e_damageVisibilityHidden	Hidden.
e_damageVisibilitySnapshot	Snapshot.
e_damageVisibilityVisible	Visible.

EEffectApplyBehaviorFlag

enum EEffectApplyBehaviorFlag

Apply Behavior Flag.

Remarks

Unknown

Enumerator
e_effectApplyBehaviorFlagUseDuration	Use Duration.

EEffectCancelOrderFlag

enum EEffectCancelOrderFlag

Cancel Order Flag.

Remarks

Unknown

Enumerator
e_effectCancelOrderFlagActive	Active.
e_effectCancelOrderFlagQueued	Queued.
e_effectCancelOrderFlagUninterruptible	Uninterruptible.

EEffectCombine

enum EEffectCombine

Effect Combine.

Remarks

Unknown

Enumerator
e_effectCombineAnd	And.
e_effectCombineOr	Or.

EEffectHealerFlag

enum EEffectHealerFlag

Healer Flag.

Remarks

Unknown

Enumerator
e_effectHealerFlagChanneled	Channeled.
e_effectHealerFlagChanneling	Channeling.

EEffectMissile

enum EEffectMissile

Missile.

Remarks

Unknown

Enumerator
e_effectMissile2D	2D
e_effectMissileChanneled	Channeled.
e_effectMissilePlacement	Placement.
e_effectMissilePlacementIgnoreBlockers	Ignore Blockers.
e_effectMissilePlacementIgnoreCliffTest	Placement Ignore Cliff Test.
e_effectMissilePointFallback	Point Fallback.
e_effectMissileRetarget	Retarget.
e_effectMissileReturn	Return.
e_effectMissileTransfer	Transfer.
e_effectMissileTravelValidation	Travel Validation.
e_effectMissileValidateAbil	Validate Ability.
e_effectMissileValidateWeapon	Weapon.

EEffectModify

enum EEffectModify

Modification Flag.

Remarks

Unknown

Enumerator
e_effectModifyCopy	Copy.
e_effectModifyOwner	Owner.
e_effectModifyHide	Hide.
e_effectModifyShow	Show.
e_effectModifyMimic	Mimic.
e_effectModifyNullifyMissile	Nullify Missile.
e_effectModifySalvage	Salvage.
e_effectModifyCopyAutoCast	Copy Auto Cast.

EEffectRedirectMissile

enum EEffectRedirectMissile

Effect Redirect Missile.

Remarks

Unknown

Enumerator
e_effectRedirectMissileOriginalValidation	Original Validation.

EEffectRevealFlag

enum EEffectRevealFlag

Reveal Flag.

Remarks

Unknown

Enumerator
e_effectRevealFlagUnfog	Unfog.
e_effectRevealFlagDetect	Detect.
e_effectRevealFlagRadar	Radar.
e_effectRevealFlagLoS	Use Line of Sight.
e_effectRevealFlagPermanent	Permanent.

EEffectTeleport

enum EEffectTeleport

Effect Teleport.

Remarks

Unknown

Enumerator
e_effectTeleportTestCliff	Test Cliff.
e_effectTeleportTestFog	Test Fog.
e_effectTeleportTestZone	Test Zone.

EMoverPatternType

enum EMoverPatternType

Mover Pattern Type.

Remarks

Enum

Enumerator
e_moverPatternTypeStripe	Stripe.
e_moverPatternTypeBounce	Bounce.

ENotifyAreaFlag

enum ENotifyAreaFlag

Notify Area Flag.

Remarks

Unknown

Enumerator
e_notifyAreaFlagHelpFriend	Help Friend.
e_notifyAreaFlagHurtFriend	Hurt Friend.
e_notifyAreaFlagHurtEnemy	Hurt Enemy.
e_notifyAreaFlagOnlyWorkers	Workers Only.
e_notifyAreaFlagMinorDanger	Minor Danger.

EResponseFlag

enum EResponseFlag

Response Flag.

Remarks

Unknown

Enumerator
e_responseFlagAcquire	Acquire.
e_responseFlagFlee	Flee.

Variable Documentation

e_classIdCEffectCount

const int32 e_classIdCEffectCount = 28

e_createPersistentCount

const int32 e_createPersistentCount = 9

e_createUnitCount

const int32 e_createUnitCount = 12

e_damageFlagCount

const int32 e_damageFlagCount = 21

e_damageSoundCount

const int32 e_damageSoundCount = 2

e_damageTotalCount

const int32 e_damageTotalCount = 3

e_damageVisibilityCount

const int32 e_damageVisibilityCount = 3

e_effectApplyBehaviorFlagCount

const int32 e_effectApplyBehaviorFlagCount = 1

e_effectCancelOrderFlagCount

const int32 e_effectCancelOrderFlagCount = 3

e_effectCombineCount

const int32 e_effectCombineCount = 2

e_effectHealerFlagCount

const int32 e_effectHealerFlagCount = 2

e_effectMissileCount

const int32 e_effectMissileCount = 12

e_effectModifyCount

const int32 e_effectModifyCount = 8

e_effectRedirectMissileCount

const int32 e_effectRedirectMissileCount = 1

e_effectRevealFlagCount

const int32 e_effectRevealFlagCount = 5

e_effectTeleportCount

const int32 e_effectTeleportCount = 3

e_moverPatternTypeCount

const int32 e_moverPatternTypeCount = 2

e_notifyAreaFlagCount

const int32 e_notifyAreaFlagCount = 5

e_responseFlagCount

const int32 e_responseFlagCount = 2