Witcher Wiki
Don't have an account?
Register
Register
Witcher Wiki
Witcher Wiki
Official wiki
14,206
pages
in: The Witcher 3 classes

W3Class CGameplayEntity

Sign in to edit
Substances Graveir bone
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!
CGameplayEntity
Signature
 import class CGameplayEntity extends CPeristentEntity
Parent
 CPeristentEntity
Sub-classes
 CActor
CBirdsArea
CBirdsManager
CBoatRacingGateEntity
CBookMinigameBook
CBookMinigameSlot
CBooksMinigameManager
CCenserTrigger
CDoorMarkingTester
CEncounter
CEncounterActivator
CFactAdderOnCollisionWithTag
CGroupFXManager
CHorseCorrectionTrigger
CHorseJumpTrigger
CMagicBombEntity
CMeteoriteStormEntity
COilBarrelEntity
CPhilippaAttractorTrigger
CProjectileTrajectory
CR4JournalPlaceEntity
CR4MapPinEntity
CSkullPileEntity
CStorySceneSpawner
CTestTrigger
CVFXTrigger
CollisionTrajectory
EP1Chandelier
W3AirDrainArea
W3AirDrainEntity
W3AnimationInteractionEntity
W3BackgroundAnimatedEntity
W3BackgroundAnimatedEntityTrigger
W3BeeSwarm
W3Bird
W3BlockGameplayActionsTrigger
W3Boat
W3BoatSpawner
W3BuffImmunityEntity
W3Campfire
W3ChangeCombatStageTrigger
W3CiriPhantom
W3CollectiblePlaces
W3CurveFish
W3CurveFishManager
W3DestructSelfEntity
W3DestructionTrigger
W3DurationObstacle
W3EffectAreaTrigger
W3Elevator
W3EnvironmentThrowable
W3FireSource
W3FocusAreaTrigger
W3FoodDispenser
W3GameplayTrigger
W3GenericSceneArea
W3IceWall
W3IllusionSpawner
W3IllusionaryObstacle
W3IrisPainting
W3KillTestTrigger
W3LadderInteraction
W3LocationArea
W3LockableEntity
W3MicroQuestActivator
W3MinimapZoomScaleTrigger
W3MonsterElementalArm
W3MonsterHuntInvestigationArea
W3NPCBackground
W3NPCBackgroundPair
W3NPCBackgroundWoman
W3POIDispenser
W3PhysicalDamageMechanism
W3PlayerModeTrigger
W3PointOfInterestEntity
W3Poster
W3RiddleNode
W3RiddleServer
W3RootsEntrance
W3SafeModeTrigger
W3SavedAppearanceEntity
W3ShepherdGreetingTrigger
W3ShowDisplayNameTrigger
W3SignEntity
W3SpawnMarker
W3StallEntity
W3SummonedFlies
W3Switch
W3ToxicCloud
W3UsableEntity
W3WeatherShrine
W3Whale
Version
 1.12
Path
 /game/gameplayEntity.ws

ISerializable > IScriptable > CObject > CNode > CEntity > CPeristentEntity

Public Functions

AddAbility

public function AddAbility(abilityName : name, optional allowMultiple : bool) : bool
Parameters:
abilityName : name
optional allowMultiple : bool
Returns:
bool
Location:
starts @ line 222, ends @ line 222

AddAbilityMultiple

public function AddAbilityMultiple(abilityName : name, count : int)
Parameters:
abilityName : name
count : int
Location:
starts @ line 224, ends @ line 224

AddAnimEventCallback

import final function AddAnimEventCallback(eventName : name, functionName : name)
Parameters:
eventName : name
functionName : name
Location:
starts @ line 103, ends @ line 103

AddAnimEventChildCallback

import final function AddAnimEventChildCallback(child : CNode, eventName : name, functionName : name)
Parameters:
child : CNode
eventName : name
functionName : name
Location:
starts @ line 107, ends @ line 107

AddCutsceneForbiddenFX

public function AddCutsceneForbiddenFX(fx : name)
Parameters:
fx : name
Location:
starts @ line 288, ends @ line 294

AddSignHitFacts

function AddSignHitFacts(sign : W3SignProjectile, signType : string)
Parameters:
sign : W3SignProjectile
signType : string
Location:
starts @ line 341, ends @ line 344

AddTag

public function AddTag(tag : name)
Parameters:
tag : name
Overrides member from: CNode
Location:
starts @ line 233, ends @ line 257

ApplyFallingDamage

function ApplyFallingDamage(heightDiff : float, optional reducing : bool) : float
Parameters:
heightDiff : float
optional reducing : bool
Returns:
float
Location:
starts @ line 525, ends @ line 528

CanShowFocusInteractionIcon

public function CanShowFocusInteractionIcon() : bool
Returns:
bool
Location:
starts @ line 635, ends @ line 638

EnableVisualDebug

import final function EnableVisualDebug(flag : EShowFlags, enable : bool)
Parameters:
flag : EShowFlags
enable : bool
Location:
starts @ line 140, ends @ line 140

FocusEffectOff

function FocusEffectOff()
Location:
starts @ line 281, ends @ line 284

GetAbilityCount

public function GetAbilityCount(abilityName : name) : int
Parameters:
abilityName : name
Returns:
int
Location:
starts @ line 227, ends @ line 227

GetAllAttributes

public final function GetAllAttributes() : array<name>
Returns:
array<name>
Location:
starts @ line 74, ends @ line 79

GetDisplayName

import final function GetDisplayName(optional fallBack : bool) : string
Parameters:
optional fallBack : bool
Returns:
string
Location:
starts @ line 85, ends @ line 85

GetFocusActionName

public function GetFocusActionName() : name
Returns:
name
Location:
starts @ line 624, ends @ line 633

GetFocusModeSoundEffectName

function GetFocusModeSoundEffectName(colorBlindMode : bool) : name
Parameters:
colorBlindMode : bool
Returns:
name
Location:
starts @ line 534, ends @ line 551

GetFocusModeVisibility

import final function GetFocusModeVisibility() : EFocusModeVisibility
Returns:
EFocusModeVisibility
Location:
starts @ line 130, ends @ line 130

GetGameplayEntityParam

import final function GetGameplayEntityParam(className : name) : CGameplayEntityParam
Parameters:
className : name
Returns:
CGameplayEntityParam
Location:
starts @ line 100, ends @ line 100

GetGameplayInfoCache

import final function GetGameplayInfoCache(type : EGameplayInfoCacheType) : bool
Parameters:
type : EGameplayInfoCacheType
Returns:
bool
Location:
starts @ line 127, ends @ line 127

GetInteractionData

public function GetInteractionData(out actionName : name, out text : string) : bool
Parameters:
out actionName : name
out text : string
Returns:
bool
Location:
starts @ line 640, ends @ line 645

GetInventory

import final function GetInventory() : CInventoryComponent
Returns:
CInventoryComponent
Location:
starts @ line 72, ends @ line 72

GetPropertyAnimationInstanceTime

import final function GetPropertyAnimationInstanceTime(propertyName : name, animationName : name) : float
Parameters:
propertyName : name
animationName : name
Returns:
float
Location:
starts @ line 94, ends @ line 94

GetPropertyAnimationLength

import final function GetPropertyAnimationLength(propertyName : name, animationName : name) : float
Parameters:
propertyName : name
animationName : name
Returns:
float
Location:
starts @ line 96, ends @ line 96

GetPropertyAnimationTransformAt

import final function GetPropertyAnimationTransformAt(propertyName : name, animationName : name, time : float) : Matrix
Parameters:
propertyName : name
animationName : name
time : float
Returns:
Matrix
Location:
starts @ line 98, ends @ line 98

GetSfxTag

import final function GetSfxTag() : CName
Returns:
CName
Location:
starts @ line 112, ends @ line 112

GetStorageBounds

import function GetStorageBounds(out box : Box)
Parameters:
out box : Box
Location:
starts @ line 115, ends @ line 115

HasAbility

public function HasAbility(abilityName : name, optional includeInventoryAbl : bool) : bool
Parameters:
abilityName : name
optional includeInventoryAbl : bool
Returns:
bool
Location:
starts @ line 221, ends @ line 221

IsAlive

public function IsAlive() : bool
Returns:
bool
Location:
starts @ line 220, ends @ line 220

IsHighlighted

public function IsHighlighted() : bool
Returns:
bool
Location:
starts @ line 309, ends @ line 312

IsVehicle

public function IsVehicle() : bool
Returns:
bool
Location:
starts @ line 520, ends @ line 523

PlayFocusSoundVisualEffect

function PlayFocusSoundVisualEffect(effectName : name)
Parameters:
effectName : name
Location:
starts @ line 553, ends @ line 576

PlayPropertyAnimation

import final function PlayPropertyAnimation(animationName : name, optional count : int, optional lengthScale : float, optional mode : EPropertyCurveMode)
Parameters:
animationName : name
optional count : int
optional lengthScale : float
optional mode : EPropertyCurveMode
Location:
starts @ line 88, ends @ line 88

RemoveAbility

public function RemoveAbility(abilityName : name)
Parameters:
abilityName : name
Location:
starts @ line 223, ends @ line 223

RemoveAbilityAll

public function RemoveAbilityAll(abilityName : name)
Parameters:
abilityName : name
Location:
starts @ line 226, ends @ line 226

RemoveAbilityMultiple

public function RemoveAbilityMultiple(abilityName : name, count : int)
Parameters:
abilityName : name
count : int
Location:
starts @ line 225, ends @ line 225

RemoveAnimEventCallback

import final function RemoveAnimEventCallback(eventName : name)
Parameters:
eventName : name
Location:
starts @ line 105, ends @ line 105

RemoveAnimEventChildCallback

import final function RemoveAnimEventChildCallback(child : CNode, eventName : name)
Parameters:
child : CNode
eventName : name
Location:
starts @ line 109, ends @ line 109

RewindPropertyAnimation

import final function RewindPropertyAnimation(animationName : name, time : float)
Parameters:
animationName : name
time : float
Location:
starts @ line 92, ends @ line 92

SenseMagic

function SenseMagic()
Location:
starts @ line 331, ends @ line 339

SetFocusModeSoundEffectType

public function SetFocusModeSoundEffectType(type : EFocusModeSoundEffectType)
Parameters:
type : EFocusModeSoundEffectType
Location:
starts @ line 578, ends @ line 596

SetFocusModeVisibility

import final function SetFocusModeVisibility(focusModeVisibility : EFocusModeVisibility, optional persistent : bool, optional force : bool)
Parameters:
focusModeVisibility : EFocusModeVisibility
optional persistent : bool
optional force : bool
Location:
starts @ line 135, ends @ line 135

SetHighlighted

public function SetHighlighted(b : bool)
Parameters:
b : bool
Location:
starts @ line 304, ends @ line 307

ShouldBlockGameplayActionsOnInteraction

public function ShouldBlockGameplayActionsOnInteraction() : bool
Returns:
bool
Location:
starts @ line 314, ends @ line 317

StopCutsceneForbiddenFXs

public function StopCutsceneForbiddenFXs()
Location:
starts @ line 295, ends @ line 302

StopPropertyAnimation

import final function StopPropertyAnimation(animationName : name, optional restoreInitialValues : bool)
Parameters:
animationName : name
optional restoreInitialValues : bool
Location:
starts @ line 90, ends @ line 90

Public Vars

aimVector

import var aimVector : Vector
Location:
defined @ line 142

focusModeSoundEffectType

public var focusModeSoundEffectType : EFocusModeSoundEffectType
Location:
defined @ line 147

focusSoundVisualEffectBoneName

var focusSoundVisualEffectBoneName : name
Location:
defined @ line 159

highlighted

public var highlighted : bool
Location:
defined @ line 145

iconOffset

editable var iconOffset : Vector
Location:
defined @ line 143

isColorBlindMode

var isColorBlindMode : bool
Location:
defined @ line 152

isHighlightedByMedallion

editable var isHighlightedByMedallion : bool
Location:
defined @ line 162

isMagicalObject

editable var isMagicalObject : bool
Location:
defined @ line 163

isPlayingFocusSound

var isPlayingFocusSound : bool
Location:
defined @ line 149

maxLootParamNumber

editable var maxLootParamNumber : int
Location:
defined @ line 70

minLootParamNumber

editable var minLootParamNumber : int
Location:
defined @ line 69

soundEntityGender

editable var soundEntityGender : string
Location:
defined @ line 171

soundEntityName

editable var soundEntityName : string
Location:
defined @ line 170

soundEntitySet

editable var soundEntitySet : string
Location:
defined @ line 172

Protected Functions

GetCharacterStats

import protected final function GetCharacterStats() : CCharacterStats
Returns:
CCharacterStats
Location:
starts @ line 73, ends @ line 73

WhenFallen

protected function WhenFallen(fallingHeightDiff : float)
Parameters:
fallingHeightDiff : float
Location:
starts @ line 491, ends @ line 518

Event Handlers

OnAardHit

event OnAardHit(sign : W3AardProjectile)
Parameters:
sign : W3AardProjectile
Location:
starts @ line 356

OnAxiiHit

event OnAxiiHit(sign : W3AxiiProjectile)
Parameters:
sign : W3AxiiProjectile
Location:
starts @ line 415

OnBoltHit

event OnBoltHit()
Location:
starts @ line 350

OnDamageFromFalling

event OnDamageFromFalling(activator : CComponent, fallingDistance : float, fallingHeightDiff : float)
Parameters:
activator : CComponent
fallingDistance : float
fallingHeightDiff : float
Location:
starts @ line 486

OnDamageFromJump

event OnDamageFromJump(activator : CComponent, jumpDistance : float, jumpHeightDiff : float)
Parameters:
activator : CComponent
jumpDistance : float
jumpHeightDiff : float
Location:
starts @ line 482

OnDestroyed

event OnDestroyed()
Location:
starts @ line 192

OnFireHit

event OnFireHit(source : CGameplayEntity)
Parameters:
source : CGameplayEntity
Location:
starts @ line 439

OnFocusModeSound

event OnFocusModeSound(enabled : bool, colorBlind : bool)
Parameters:
enabled : bool
colorBlind : bool
Location:
starts @ line 598

OnFrostHit

event OnFrostHit(source : CGameplayEntity)
Parameters:
source : CGameplayEntity
Location:
starts @ line 420

OnGameplayPropertyChanged

event OnGameplayPropertyChanged(propertyName : name)
Parameters:
propertyName : name
Location:
starts @ line 177

OnIgniHit

event OnIgniHit(sign : W3IgniProjectile)
Parameters:
sign : W3IgniProjectile
Location:
starts @ line 391

OnItemGiven

event OnItemGiven(data : SItemChangedData)
Parameters:
data : SItemChangedData
Location:
starts @ line 323

OnItemTaken

event OnItemTaken(itemId : SItemUniqueId, quantity : int)
Parameters:
itemId : SItemUniqueId
quantity : int
Location:
starts @ line 326

OnPlayerActionEnd

event OnPlayerActionEnd()
Location:
starts @ line 197

OnPlayerActionStartFinished

event OnPlayerActionStartFinished()
Location:
starts @ line 202

OnPreAttackEvent

event OnPreAttackEvent(animEventName : name, animEventType : EAnimationEventType, data : CPreAttackEventData, animInfo : SAnimationEventAnimInfo)
Parameters:
animEventName : name
animEventType : EAnimationEventType
data : CPreAttackEventData
animInfo : SAnimationEventAnimInfo
Location:
starts @ line 212

OnRootHit

event OnRootHit()
Location:
starts @ line 471

OnSpawned

event OnSpawned(spawnData : SEntitySpawnData)
Parameters:
spawnData : SEntitySpawnData
Overrides member from: CPeristentEntity
Location:
starts @ line 180

OnSpawnedEditor

event OnSpawnedEditor(spawnData : SEntitySpawnData)
Parameters:
spawnData : SEntitySpawnData
Location:
starts @ line 82

OnSyncAnimEnd

event OnSyncAnimEnd()
Location:
starts @ line 207

OnWeaponHit

event OnWeaponHit(act : W3DamageAction)
Parameters:
act : W3DamageAction
Location:
starts @ line 346

OnYrdenHit

event OnYrdenHit(caster : CGameplayEntity)
Parameters:
caster : CGameplayEntity
Location:
starts @ line 464

Uninteresting Sub-Classes

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

W3IceWall

class W3IceWall extends CGameplayEntity
Location:
/game/gameplay/interactive/iceWall.ws starts @ line 9, ends @ line 18

W3ShowDisplayNameTrigger

class W3ShowDisplayNameTrigger extends CGameplayEntity
Location:
/game/gameplay/gameplay_triggers/showDisplayNameTrigger.ws starts @ line 10, ends @ line 13
Community content is available under CC BY-SA 3.0 unless otherwise noted.
More Fandoms

Fan Feed

More Witcher Wiki