W3Class CBaseGameplayEffect

Not Stable Yet!

This article is part of the Witcher 3 scripting community documentation, which is considered to be UNSTABLE until after the release of the Blood and Wine DLC. Edits to these pages may be overwritten without notice!

CBaseGameplayEffect
Signature	class CBaseGameplayEffect extends CObject
Parent	CObject
Sub-classes	W3ApplicatorEffect W3ChangeMaxStatEffect W3CriticalEffect W3DamageOverTimeEffect W3Effect_AbilityOnLowHP W3Effect_AdrenalineDrain W3Effect_AirDrain W3Effect_AirDrainDive W3Effect_AxiiGuardMe W3Effect_BattleTrance W3Effect_DoTHPRegenReduce W3Effect_DoppelgangerEssenceRegen W3Effect_Drunkenness W3Effect_LowHealth W3Effect_Oil W3Effect_OverEncumbered W3Effect_Runeword8 W3Effect_Shrine W3Effect_SilverDust W3Effect_Slowdown W3Effect_SlowdownFrost W3Effect_StaminaDrain W3Effect_StaminaDrainSwimming W3Effect_Toxicity W3Effect_Weaken W3Effect_WeatherBonus W3Effect_WolfHour W3HitSeverityEffect W3Mutagen_Effect W3Potion_Blizzard W3Potion_Cat W3Potion_Fact W3Potion_GoldenOriole W3Potion_MariborForest W3Potion_Pheromone W3Potion_WhiteHoney W3Potion_WhiteRaffardDecoction W3RaisePowerStatEffect W3RegenEffect W3RepairObjectEnhancement
Version	1.12
Path	/game/gameplay/effects/effects/baseEffect.ws

ISerializable > IScriptable > CObject

Public Functions

CacheSettings

public function CacheSettings()

Location:

starts @ line 185, ends @ line 283

CanBeAppliedOnDeadTarget

public function CanBeAppliedOnDeadTarget() : bool

Returns:

bool

Location:

starts @ line 816, ends @ line 816

CheckCustomCounter

public function CheckCustomCounter()

Location:

starts @ line 608, ends @ line 609

CumulateWith

public function CumulateWith(effect : CBaseGameplayEffect)

Parameters:

effect : CBaseGameplayEffect

Location:

starts @ line 574, ends @ line 602

Debug_HAX_FIX

public final function Debug_HAX_FIX(t : CActor)

Parameters:

t : CActor

Location:

starts @ line 834, ends @ line 838

GetAbilityName

public function GetAbilityName() : name

Returns:

name

Location:

starts @ line 338, ends @ line 341

GetBuffLevel

public function GetBuffLevel() : int

Returns:

int

Location:

starts @ line 820, ends @ line 832

GetBuffResist

public function GetBuffResist() : float

Returns:

float

Location:

starts @ line 818, ends @ line 818

GetCreator

public function GetCreator() : CGameplayEntity

Returns:

CGameplayEntity

Location:

starts @ line 746, ends @ line 749

GetCreatorPowerStat

public function GetCreatorPowerStat() : SAbilityAttributeValue

Returns:

SAbilityAttributeValue

Location:

starts @ line 859, ends @ line 862

GetDurationLeft

public function GetDurationLeft() : float

Returns:

float

Location:

starts @ line 740, ends @ line 740

GetEffectDescriptionLocalisationKey

public function GetEffectDescriptionLocalisationKey() : string

Returns:

string

Location:

starts @ line 806, ends @ line 806

GetEffectNameLocalisationKey

public function GetEffectNameLocalisationKey() : string

Returns:

string

Location:

starts @ line 758, ends @ line 804

GetEffectType

public function GetEffectType() : EEffectType

Returns:

EEffectType

Location:

starts @ line 807, ends @ line 807

GetEffectValue

public function GetEffectValue() : SAbilityAttributeValue

Returns:

SAbilityAttributeValue

Location:

starts @ line 873, ends @ line 876

GetIcon

public function GetIcon() : string

Returns:

string

Location:

starts @ line 755, ends @ line 755

GetInitialDuration

public function GetInitialDuration() : float

Returns:

float

Location:

starts @ line 743, ends @ line 743

GetInteraction

public final function GetInteraction(effect : CBaseGameplayEffect) : EEffectInteract

Parameters:

effect : CBaseGameplayEffect

Returns:

EEffectInteract

Location:

starts @ line 504, ends @ line 535

GetResistStat

public function GetResistStat() : ECharacterDefenseStats

Returns:

ECharacterDefenseStats

Location:

starts @ line 817, ends @ line 817

GetSourceName

public function GetSourceName() : string

Returns:

string

Location:

starts @ line 813, ends @ line 813

GetTargetEffectName

public function GetTargetEffectName() : name

Returns:

name

Location:

starts @ line 854, ends @ line 857

GetTimeActive

public function GetTimeActive() : float

Returns:

float

Location:

starts @ line 815, ends @ line 815

GetTimeLeft

public function GetTimeLeft() : float

Returns:

float

Location:

starts @ line 811, ends @ line 811

GetVibratePadHighFreq

public function GetVibratePadHighFreq() : float

Returns:

float

Location:

starts @ line 869, ends @ line 872

GetVibratePadLowFreq

public function GetVibratePadLowFreq() : float

Returns:

float

Location:

starts @ line 864, ends @ line 867

Init

public function Init(params : SEffectInitInfo)

Parameters:

params : SEffectInitInfo

Location:

starts @ line 106, ends @ line 155

IsActive

public function IsActive() : bool

Returns:

bool

Location:

starts @ line 756, ends @ line 756

IsNegative

public function IsNegative() : bool

Returns:

bool

Location:

starts @ line 752, ends @ line 752

IsNeutral

public function IsNeutral() : bool

Returns:

bool

Location:

starts @ line 753, ends @ line 753

IsOnPlayer

public function IsOnPlayer() : bool

Returns:

bool

Location:

starts @ line 814, ends @ line 814

IsPaused

public function IsPaused(optional sourceName : name) : bool

Parameters:

optional sourceName : name

Returns:

bool

Location:

starts @ line 723, ends @ line 737

IsPausedDuringDialogAndCutscene

public function IsPausedDuringDialogAndCutscene() : bool

Returns:

bool

Location:

starts @ line 812, ends @ line 812

IsPositive

public function IsPositive() : bool

Returns:

bool

Location:

starts @ line 751, ends @ line 751

IsPotionEffect

public function IsPotionEffect() : bool

Returns:

bool

Location:

starts @ line 808, ends @ line 808

IsSignEffect

public function IsSignEffect() : bool

Returns:

bool

Location:

starts @ line 809, ends @ line 809

OnLoad

public function OnLoad(t : CActor, eff : W3EffectManager)

Parameters:

t : CActor

eff : W3EffectManager

Location:

starts @ line 158, ends @ line 168

OnTargetDeath

public function OnTargetDeath()

Location:

starts @ line 487, ends @ line 490

OnTargetDeathAnimFinished

public function OnTargetDeathAnimFinished()

Location:

starts @ line 497, ends @ line 497

OnTargetUnconscious

public function OnTargetUnconscious()

Location:

starts @ line 492, ends @ line 495

OnTimeUpdated

public function OnTimeUpdated(dt : float)

Parameters:

dt : float

Location:

starts @ line 612, ends @ line 644

Pause

public function Pause(sourceName : name, optional singleLock : bool)

Parameters:

sourceName : name

optional singleLock : bool

Location:

starts @ line 647, ends @ line 679

RecalcDuration

public function RecalcDuration()

Location:

starts @ line 286, ends @ line 302

RecalcPotionDuration

public final function RecalcPotionDuration()

Location:

starts @ line 840, ends @ line 852

Resume

public final function Resume(sourceName : name)

Parameters:

sourceName : name

Location:

starts @ line 684, ends @ line 687

ResumeForced

public final function ResumeForced()

Location:

starts @ line 690, ends @ line 693

SetTimeLeft

public function SetTimeLeft(t : float)

Parameters:

t : float

Location:

starts @ line 810, ends @ line 810

ShowOnHUD

public function ShowOnHUD() : bool

Returns:

bool

Location:

starts @ line 754, ends @ line 754

UsesCustomCounter

public function UsesCustomCounter() : bool

Returns:

bool

Location:

starts @ line 757, ends @ line 757

Protected Functions

CalculateDuration

protected function CalculateDuration(optional setInitialDuration : bool)

Parameters:

optional setInitialDuration : bool

Location:

starts @ line 305, ends @ line 336

GetEffectStrength

protected function GetEffectStrength() : float

Returns:

float

Location:

starts @ line 567, ends @ line 571

GetSelfInteraction

protected function GetSelfInteraction(e : CBaseGameplayEffect) : EEffectInteract

Parameters:

e : CBaseGameplayEffect

Returns:

EEffectInteract

Location:

starts @ line 538, ends @ line 564

OnPaused

protected function OnPaused()

Location:

starts @ line 681, ends @ line 681

OnResumed

protected function OnResumed()

Location:

starts @ line 682, ends @ line 682

PlayTargetFX

protected function PlayTargetFX()

Location:

starts @ line 408, ends @ line 419

SetEffectValue

protected function SetEffectValue()

Location:

starts @ line 171, ends @ line 182

StopTargetFX

protected function StopTargetFX()

Location:

starts @ line 422, ends @ line 433

Protected Vars

abilityName

protected var abilityName : name

Location:

defined @ line 49

attributeName

protected var attributeName : name

Location:

defined @ line 50

cameraEffectName

protected var cameraEffectName : name

Location:

defined @ line 70

canBeAppliedOnDeadTarget

protected var canBeAppliedOnDeadTarget : bool

Location:

defined @ line 27

creatorHandle

protected var creatorHandle : EntityHandle

Location:

defined @ line 53

creatorPowerStat

protected var creatorPowerStat : SAbilityAttributeValue

Location:

defined @ line 24

deny

protected var deny : array<EEffectType>

Location:

defined @ line 63

dontAddAbilityOnTarget

protected var dontAddAbilityOnTarget : bool

Location:

defined @ line 26

duration

protected var duration : float

Location:

defined @ line 17

effectDescriptionLocalisationKey

protected var effectDescriptionLocalisationKey : string

Location:

defined @ line 82

effectManager

protected var effectManager : W3EffectManager

Location:

defined @ line 28

effectNameLocalisationKey

protected var effectNameLocalisationKey : string

Location:

defined @ line 81

effectType

protected const var effectType : EEffectType

Location:

defined @ line 51

effectValue

protected var effectValue : SAbilityAttributeValue

Location:

defined @ line 54

iconPath

protected var iconPath : string

Location:

defined @ line 79

initialDuration

protected saved var initialDuration : float

Location:

defined @ line 16

isActive

protected var isActive : bool

Location:

defined @ line 20

isCameraEffectNameValid

protected var isCameraEffectNameValid : bool

Location:

defined @ line 73

isNegative

protected var isNegative : bool

Location:

defined @ line 40

isNeutral

protected var isNeutral : bool

Location:

defined @ line 39

isOnPlayer

protected var isOnPlayer : bool

Location:

defined @ line 46

isPausedDuringDialogAndCutscene

protected var isPausedDuringDialogAndCutscene : bool

Location:

defined @ line 25

isPlayingCameraEffect

protected var isPlayingCameraEffect : bool

Location:

defined @ line 71

isPositive

protected var isPositive : bool

Location:

defined @ line 38

isPotionEffect

protected var isPotionEffect : bool

Location:

defined @ line 48

isSignEffect

protected var isSignEffect : bool

Location:

defined @ line 47

override

protected var override : array<EEffectType>

Location:

defined @ line 64

pauseCounters

protected var pauseCounters : array<SBuffPauseLock>

Location:

defined @ line 19

potionItemName

protected var potionItemName : name

Location:

defined @ line 55

resistance

protected var resistance : float

Location:

defined @ line 23

shouldPlayTargetEffect

protected var shouldPlayTargetEffect : bool

Location:

defined @ line 91

showOnHUD

protected var showOnHUD : bool

Location:

defined @ line 80

sourceName

protected var sourceName : string

Location:

defined @ line 65

switchCameraEffect

protected var switchCameraEffect : bool

Location:

defined @ line 72

target

protected var target : CActor

Location:

defined @ line 52

targetEffectName

protected var targetEffectName : name

Location:

defined @ line 90

timeActive

protected var timeActive : float

Location:

defined @ line 15

timeLeft

protected var timeLeft : float

Location:

defined @ line 18

usesCustomCounter

protected var usesCustomCounter : bool

Location:

defined @ line 21

Event Handlers

OnEffectAdded

event OnEffectAdded(optional customParams : W3BuffCustomParams)

Parameters:

optional customParams : W3BuffCustomParams

Location:

starts @ line 358

OnEffectAddedPost

event OnEffectAddedPost()

Location:

starts @ line 344

OnEffectRemoved

event OnEffectRemoved()

Location:

starts @ line 436

OnUpdate

event OnUpdate(dt : float)

Parameters:

dt : float

Location:

starts @ line 465

Uninteresting Sub-Classes

These sub-classes have no public/protected members that are not overrides of their parent and have been merged here.

W3Effect_AbilityOnLowHP

class W3Effect_AbilityOnLowHP extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/abilityOnLowHP.ws starts @ line 10, ends @ line 68

W3Effect_AdrenalineDrain

class W3Effect_AdrenalineDrain extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/auto/adrenaline.ws starts @ line 10, ends @ line 52

W3Effect_AirDrain

class W3Effect_AirDrain extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/drain/airDrain.ws starts @ line 10, ends @ line 62

W3Effect_AirDrainDive

class W3Effect_AirDrainDive extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/drain/airDrainDiving.ws starts @ line 10, ends @ line 116

W3Effect_DoTHPRegenReduce

class W3Effect_DoTHPRegenReduce extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/damageOverTime/dotRegenPause.ws starts @ line 9, ends @ line 21

W3Effect_DoppelgangerEssenceRegen

class W3Effect_DoppelgangerEssenceRegen extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/doppelgangerEssenceRegen.ws starts @ line 10, ends @ line 66

W3Effect_Drunkenness

class W3Effect_Drunkenness extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/drunkenness.ws starts @ line 9, ends @ line 47

W3Effect_LowHealth

class W3Effect_LowHealth extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/lowHealth.ws starts @ line 10, ends @ line 16

W3Effect_OverEncumbered

class W3Effect_OverEncumbered extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/overEncumbered.ws starts @ line 9, ends @ line 52

W3Effect_Runeword8

class W3Effect_Runeword8 extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/runeword8.ws starts @ line 6, ends @ line 60

W3Effect_SilverDust

class W3Effect_SilverDust extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/silverDust.ws starts @ line 9, ends @ line 60

W3Effect_Slowdown

class W3Effect_Slowdown extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/slowdown.ws starts @ line 12, ends @ line 86

W3Effect_SlowdownAxii

class W3Effect_SlowdownAxii extends W3Effect_Slowdown

Location:

/game/gameplay/effects/effects/other/slowdownAxii.ws starts @ line 6, ends @ line 9

W3Effect_SlowdownFrost

class W3Effect_SlowdownFrost extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/slowdownFrost.ws starts @ line 6, ends @ line 28

W3Effect_StaminaDrain

class W3Effect_StaminaDrain extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/drain/staminaDrain.ws starts @ line 10, ends @ line 77

W3Effect_StaminaDrainSwimming

class W3Effect_StaminaDrainSwimming extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/drain/staminaDrainSwimming.ws starts @ line 10, ends @ line 102

W3Effect_Weaken

class W3Effect_Weaken extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/weaken.ws starts @ line 6, ends @ line 11

W3Effect_WeatherBonus

class W3Effect_WeatherBonus extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/weatherBonus.ws starts @ line 9, ends @ line 15

W3Effect_WolfHour

class W3Effect_WolfHour extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/other/wolfHour.ws starts @ line 6, ends @ line 26

W3HitSeverityEffect

abstract class W3HitSeverityEffect extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/hitSeverity.ws starts @ line 10, ends @ line 13

W3Potion_Cat

class W3Potion_Cat extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/potion/Cat.ws starts @ line 9, ends @ line 125

W3Potion_GoldenOriole

class W3Potion_GoldenOriole extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/potion/GoldenOriole.ws starts @ line 10, ends @ line 67

W3Potion_MariborForest

class W3Potion_MariborForest extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/potion/MariborForest.ws starts @ line 10, ends @ line 28

W3Potion_Pheromone

class W3Potion_Pheromone extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/potion/Pheromone.ws starts @ line 9, ends @ line 24

W3Potion_PheromoneBear

class W3Potion_PheromoneBear extends W3Potion_Pheromone

Location:

/game/gameplay/effects/effects/potion/PheromoneBear.ws starts @ line 16, ends @ line 34

W3Potion_PheromoneDrowner

class W3Potion_PheromoneDrowner extends W3Potion_Pheromone

Location:

/game/gameplay/effects/effects/potion/PheromoneDrowner.ws starts @ line 16, ends @ line 31

W3Potion_PheromoneNekker

class W3Potion_PheromoneNekker extends W3Potion_Pheromone

Location:

/game/gameplay/effects/effects/potion/PheromoneNekker.ws starts @ line 16, ends @ line 31

W3Potion_WhiteHoney

class W3Potion_WhiteHoney extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/potion/WhiteHoney.ws starts @ line 10, ends @ line 33

W3Potion_WhiteRaffardDecoction

class W3Potion_WhiteRaffardDecoction extends CBaseGameplayEffect

Location:

/game/gameplay/effects/effects/potion/WhiteRaffardDecoction.ws starts @ line 10, ends @ line 42