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!
ISerializable > IScriptable > CObject > CNode
Public Functions
ActivateAndSyncBehavior
import final latent function ActivateAndSyncBehavior(names : name , optional timeout : float ) : bool
Parameters:
names : name
optional timeout : float Returns:
bool Location:
starts @ line 210, ends @ line 210
ActivateAndSyncBehaviors
import final latent function ActivateAndSyncBehaviors(names : array <name >, optional timeout : float ) : bool
Parameters:
names : array <name >
optional timeout : float Returns:
bool Location:
starts @ line 207, ends @ line 207
ActivateBehaviors
import final latent function ActivateBehaviors(names : array <name >) : bool
Parameters:
names : array <name > Returns:
bool Location:
starts @ line 202, ends @ line 202
import final function ActivateBehaviorsSync(names : array <name >) : bool
Parameters:
names : array <name > Returns:
bool Location:
starts @ line 204, ends @ line 204
AddGameTimeTimer
import final function AddGameTimeTimer(timerName : name , period : GameTime , optional repeats : bool , optional scatter : bool , optional group : ETickGroup, optional saveable : bool , optional overrideExisting : bool ) : int
Parameters:
timerName : name
period : GameTime
optional repeats : bool
optional scatter : bool
optional group : ETickGroup
optional saveable : bool
optional overrideExisting : bool Returns:
int Location:
starts @ line 28, ends @ line 28
AddTimer
import final function AddTimer(timerName : name , period : float , optional repeats : bool , optional scatter : bool , optional group : ETickGroup, optional saveable : bool , optional overrideExisting : bool ) : int
Parameters:
timerName : name
period : float
optional repeats : bool
optional scatter : bool
optional group : ETickGroup
optional saveable : bool
optional overrideExisting : bool Returns:
int Location:
starts @ line 26, ends @ line 26
ApplyAppearance
function ApplyAppearance(appearanceName : string )
Parameters:
appearanceName : string Location:
starts @ line 371, ends @ line 379
AttachBehavior
import final latent function AttachBehavior(instanceName : name ) : bool
Parameters:
instanceName : name Returns:
bool Location:
starts @ line 213, ends @ line 213
AttachBehaviorSync
import final function AttachBehaviorSync(instanceName : name ) : bool
Parameters:
instanceName : name Returns:
bool Location:
starts @ line 216, ends @ line 216
BehaviorNodeDeactivationNotificationReceived
import final function BehaviorNodeDeactivationNotificationReceived(deactivationName : name ) : bool
Parameters:
deactivationName : name Returns:
bool Location:
starts @ line 88, ends @ line 88
BreakAttachment
import function BreakAttachment() : bool
Returns:
bool Location:
starts @ line 332, ends @ line 332
BreakChildAttachment
import function BreakChildAttachment(child : CNode , optional slot : name ) : bool
Parameters:
child : CNode
optional slot : name Returns:
bool Location:
starts @ line 340, ends @ line 340
CalcBoundingBox
import function CalcBoundingBox(out box : Box )
Parameters:
out box : Box Location:
starts @ line 93, ends @ line 93
CalcEntitySlotMatrix
import final function CalcEntitySlotMatrix(slot : name , out slotMatrix : Matrix ) : bool
Parameters:
slot : name
out slotMatrix : Matrix Returns:
bool Location:
starts @ line 181, ends @ line 181
CreateAttachment
import function CreateAttachment(parentEntity : CEntity, optional entityTemplateSlot : name , optional relativePosition : Vector , optional relativeRotation : EulerAngles ) : bool
Parameters:
parentEntity : CEntity
optional entityTemplateSlot : name
optional relativePosition : Vector
optional relativeRotation : EulerAngles Returns:
bool Location:
starts @ line 331, ends @ line 331
CreateAttachmentAtBoneWS
import function CreateAttachmentAtBoneWS(parentEntity : CEntity, bone : name , worldLocation : Vector , worldRotation : EulerAngles ) : bool
Parameters:
parentEntity : CEntity
bone : name
worldLocation : Vector
worldRotation : EulerAngles Returns:
bool Location:
starts @ line 337, ends @ line 337
CreateChildAttachment
import function CreateChildAttachment(child : CNode , optional slot : name ) : bool
Parameters:
child : CNode
optional slot : name Returns:
bool Location:
starts @ line 339, ends @ line 339
Destroy
import final function Destroy()
Location:
starts @ line 41, ends @ line 41
DestroyAfter
function DestroyAfter(time : float )
Parameters:
time : float Location:
starts @ line 381, ends @ line 384
DestroyAllEffects
import function DestroyAllEffects()
Location:
starts @ line 267, ends @ line 267
DestroyEffect
import function DestroyEffect(effectName : name ) : bool
Parameters:
effectName : name Returns:
bool Location:
starts @ line 265, ends @ line 265
DetachBehavior
import final function DetachBehavior(instanceName : name ) : bool
Parameters:
instanceName : name Returns:
bool Location:
starts @ line 219, ends @ line 219
Duplicate
import final function Duplicate(optional placeOnLayer : CLayer) : CEntity
Parameters:
optional placeOnLayer : CLayer Returns:
CEntity Location:
starts @ line 46, ends @ line 46
Fade
import final function Fade(fadeIn : bool )
Parameters:
fadeIn : bool Location:
starts @ line 240, ends @ line 240
GetBehaviorGraphInstanceName
import final function GetBehaviorGraphInstanceName(optional index : int ) : name
Parameters:
optional index : int Returns:
name Location:
starts @ line 234, ends @ line 234
GetBehaviorVariable
import final function GetBehaviorVariable(varName : name , optional defaultValue : float ) : float
Parameters:
varName : name
optional defaultValue : float Returns:
float Location:
starts @ line 222, ends @ line 222
GetBehaviorVectorVariable
import final function GetBehaviorVectorVariable(varName : name ) : Vector
Parameters:
varName : name Returns:
Vector Location:
starts @ line 225, ends @ line 225
GetBoneIndex
import final function GetBoneIndex(bone : name ) : int
Parameters:
bone : name Returns:
int Location:
starts @ line 190, ends @ line 190
GetBoneReferenceMatrixMS
import final function GetBoneReferenceMatrixMS(boneIndex : int ) : Matrix
Parameters:
boneIndex : int Returns:
Matrix Location:
starts @ line 187, ends @ line 187
GetBoneWorldMatrix
final function GetBoneWorldMatrix(boneName : name ) : Matrix
Parameters:
boneName : name Returns:
Matrix Location:
starts @ line 164, ends @ line 177
GetBoneWorldMatrixByIndex
import final function GetBoneWorldMatrixByIndex(boneIndex : int ) : Matrix
Parameters:
boneIndex : int Returns:
Matrix Location:
starts @ line 184, ends @ line 184
GetBoneWorldPosition
final function GetBoneWorldPosition(boneName : name ) : Vector
Parameters:
boneName : name Returns:
Vector Location:
starts @ line 101, ends @ line 116
GetBoneWorldPositionAndRotationByIndex
final function GetBoneWorldPositionAndRotationByIndex(boneIndex : int , out position : Vector , out rotation : EulerAngles )
Parameters:
boneIndex : int
out position : Vector
out rotation : EulerAngles Location:
starts @ line 146, ends @ line 162
GetBoneWorldPositionByIndex
final function GetBoneWorldPositionByIndex(boneIndex : int ) : Vector
Parameters:
boneIndex : int Returns:
Vector Location:
starts @ line 118, ends @ line 130
GetBoneWorldRotationByIndex
final function GetBoneWorldRotationByIndex(boneIndex : int ) : EulerAngles
Parameters:
boneIndex : int Returns:
EulerAngles Location:
starts @ line 132, ends @ line 144
GetComponent GetComponentByClassName
import function GetComponentByClassName(className : name ) : CComponent
Parameters:
className : name Returns:
CComponent Location:
starts @ line 251, ends @ line 251
GetComponentByUsedBoneName GetComponentsByClassName GetComponentsCountByClassName
import function GetComponentsCountByClassName(className : name ) : int
Parameters:
className : name Returns:
int Location:
starts @ line 259, ends @ line 259
GetGuidHash
import function GetGuidHash() : int
Returns:
int Location:
starts @ line 312, ends @ line 312
GetMoveHeading
import final function GetMoveHeading() : float
Returns:
float Location:
starts @ line 196, ends @ line 196
GetMoveTarget
import final function GetMoveTarget() : Vector
Returns:
Vector Location:
starts @ line 193, ends @ line 193
GetReadableName
function GetReadableName() : string
Returns:
string Location:
starts @ line 356, ends @ line 368
GetRootAnimatedComponent HasAttachment
import function HasAttachment() : bool
Returns:
bool Location:
starts @ line 333, ends @ line 333
HasChildAttachment
import function HasChildAttachment(child : CNode ) : bool
Parameters:
child : CNode Returns:
bool Location:
starts @ line 341, ends @ line 341
HasEffect
import function HasEffect(effectName : name ) : bool
Parameters:
effectName : name Returns:
bool Location:
starts @ line 274, ends @ line 274
HasSlot
import function HasSlot(slotName : name , optional recursive : bool ) : bool
Parameters:
slotName : name
optional recursive : bool Returns:
bool Location:
starts @ line 334, ends @ line 334
HasTagInLayer
import final function HasTagInLayer(tag : name ) : bool
Parameters:
tag : name Returns:
bool Location:
starts @ line 36, ends @ line 36
I_GetDisplayName
import function I_GetDisplayName() : string
Returns:
string Location:
starts @ line 91, ends @ line 91
IsEffectActive
import function IsEffectActive(effectName : name , optional treatStoppingAsActive : bool ) : bool
Parameters:
effectName : name
optional treatStoppingAsActive : bool Returns:
bool Location:
starts @ line 271, ends @ line 271
IsRagdolled
import function IsRagdolled() : bool
Returns:
bool Location:
starts @ line 309, ends @ line 309
IsStatic
import function IsStatic() : bool
Returns:
bool Location:
starts @ line 310, ends @ line 310
PlayEffect
import function PlayEffect(effectName : name , optional target : CNode ) : bool
Parameters:
effectName : name
optional target : CNode Returns:
bool Location:
starts @ line 262, ends @ line 262
PlayEffectOnBone
import function PlayEffectOnBone(effectName : name , boneName : name , optional target : CNode ) : bool
Parameters:
effectName : name
boneName : name
optional target : CNode Returns:
bool Location:
starts @ line 263, ends @ line 263
PlayEffectSingle
public function PlayEffectSingle(effectName : name , optional target : CNode ) : bool
Parameters:
effectName : name
optional target : CNode Returns:
bool Location:
starts @ line 276, ends @ line 282
PreloadBehaviorsToActivate
import final latent function PreloadBehaviorsToActivate(names : array <name >) : bool
Parameters:
names : array <name > Returns:
bool Location:
starts @ line 199, ends @ line 199
PreloadEffect
import function PreloadEffect(effectName : name ) : bool
Parameters:
effectName : name Returns:
bool Location:
starts @ line 304, ends @ line 304
PreloadEffectForAnimation
import function PreloadEffectForAnimation(animName : name ) : bool
Parameters:
animName : name Returns:
bool Location:
starts @ line 305, ends @ line 305
RaiseEvent
import final function RaiseEvent(eventName : name ) : bool
Parameters:
eventName : name Returns:
bool Location:
starts @ line 65, ends @ line 65
RaiseEventWithoutTestCheck
import final function RaiseEventWithoutTestCheck(eventName : name ) : bool
Parameters:
eventName : name Returns:
bool Location:
starts @ line 71, ends @ line 71
RaiseForceEvent
import final function RaiseForceEvent(eventName : name ) : bool
Parameters:
eventName : name Returns:
bool Location:
starts @ line 68, ends @ line 68
RaiseForceEventWithoutTestCheck
import final function RaiseForceEventWithoutTestCheck(eventName : name ) : bool
Parameters:
eventName : name Returns:
bool Location:
starts @ line 72, ends @ line 72
RemoveTag
public final function RemoveTag(tag : name )
Parameters:
tag : name Location:
starts @ line 401, ends @ line 408
RemoveTimer
import final function RemoveTimer(timerName : name , optional group : ETickGroup)
Parameters:
timerName : name
optional group : ETickGroup Location:
starts @ line 30, ends @ line 30
RemoveTimerById
import final function RemoveTimerById(id : int , optional group : ETickGroup)
Parameters:
id : int
optional group : ETickGroup Location:
starts @ line 32, ends @ line 32
RemoveTimers
import final function RemoveTimers()
Location:
starts @ line 34, ends @ line 34
SetAutoEffect
import function SetAutoEffect(effectName : name ) : bool
Parameters:
effectName : name Returns:
bool Location:
starts @ line 261, ends @ line 261
SetBehaviorVariable
import final function SetBehaviorVariable(varName : name , varValue : float , optional inAllInstances : bool ) : bool
Parameters:
varName : name
varValue : float
optional inAllInstances : bool Returns:
bool Location:
starts @ line 228, ends @ line 228
SetBehaviorVectorVariable
import final function SetBehaviorVectorVariable(varName : name , varValue : Vector , optional inAllInstances : bool ) : bool
Parameters:
varName : name
varValue : Vector
optional inAllInstances : bool Returns:
bool Location:
starts @ line 231, ends @ line 231
SetEffectIntensity
import function SetEffectIntensity(effectName : name , intensity : float , optional specificComponentName : name , optional effectParameterName : name )
Parameters:
effectName : name
intensity : float
optional specificComponentName : name
optional effectParameterName : name Location:
starts @ line 273, ends @ line 273
SetHideInGame
import final function SetHideInGame(hide : bool )
Parameters:
hide : bool Location:
starts @ line 243, ends @ line 243
SetKinematic
import function SetKinematic(enable : bool )
Parameters:
enable : bool Location:
starts @ line 307, ends @ line 307
SetStatic
import function SetStatic()
Location:
starts @ line 308, ends @ line 308
SoundEvent
import function SoundEvent(eventName : string , optional boneName : name , optional isSlot : bool )
Parameters:
eventName : string
optional boneName : name
optional isSlot : bool Location:
starts @ line 294, ends @ line 294
SoundIsActive
import function SoundIsActive(boneName : name , optional isSlot : bool ) : bool
Parameters:
boneName : name
optional isSlot : bool Returns:
bool Location:
starts @ line 302, ends @ line 302
SoundIsActiveAny
import function SoundIsActiveAny() : bool
Returns:
bool Location:
starts @ line 300, ends @ line 300
SoundIsActiveName
import function SoundIsActiveName(eventName : name ) : bool
Parameters:
eventName : name Returns:
bool Location:
starts @ line 301, ends @ line 301
SoundParameter
import function SoundParameter(parameterName : string , value : float , optional boneName : name , optional duration : float , optional isSlot : bool )
Parameters:
parameterName : string
value : float
optional boneName : name
optional duration : float
optional isSlot : bool Location:
starts @ line 299, ends @ line 299
SoundSwitch
import function SoundSwitch(swichGroupName : string , optional stateName : string , optional boneName : name , optional isSlot : bool )
Parameters:
swichGroupName : string
optional stateName : string
optional boneName : name
optional isSlot : bool Location:
starts @ line 297, ends @ line 297
StopAllEffects
import function StopAllEffects()
Location:
starts @ line 266, ends @ line 266
StopAllEffectsAfter
function StopAllEffectsAfter(time : float )
Parameters:
time : float Location:
starts @ line 386, ends @ line 389
StopEffect
import function StopEffect(effectName : name ) : bool
Parameters:
effectName : name Returns:
bool Location:
starts @ line 264, ends @ line 264
StopEffectIfActive
public function StopEffectIfActive(effectName : name ) : bool
Parameters:
effectName : name Returns:
bool Location:
starts @ line 284, ends @ line 291
Teleport
import final function Teleport(position : Vector )
Parameters:
position : Vector Location:
starts @ line 51, ends @ line 51
TeleportToNode
import final function TeleportToNode(node : CNode , optional applyRotation : bool ) : bool
Parameters:
node : CNode
optional applyRotation : bool Returns:
bool Location:
starts @ line 57, ends @ line 57
TeleportWithRotation
import final function TeleportWithRotation(position : Vector , rotation : EulerAngles )
Parameters:
position : Vector
rotation : EulerAngles Location:
starts @ line 54, ends @ line 54
WaitForAnimationEvent
import final latent function WaitForAnimationEvent(animEventName : name , timeout : float ) : bool
Parameters:
animEventName : name
timeout : float Returns:
bool Location:
starts @ line 85, ends @ line 85
WaitForBehaviorNodeActivation
import final latent function WaitForBehaviorNodeActivation(activationName : name , timeout : float ) : bool
Parameters:
activationName : name
timeout : float Returns:
bool Location:
starts @ line 79, ends @ line 79
WaitForBehaviorNodeDeactivation
import final latent function WaitForBehaviorNodeDeactivation(deactivationName : name , timeout : float ) : bool
Parameters:
deactivationName : name
timeout : float Returns:
bool Location:
starts @ line 82, ends @ line 82
WaitForEventProcessing
import final latent function WaitForEventProcessing(eventName : name , timeout : float ) : bool
Parameters:
eventName : name
timeout : float Returns:
bool Location:
starts @ line 76, ends @ line 76
Protected Functions
SnapComponent SnapComponentByName
protected function SnapComponentByName(componentName : name , maxHeightDown : float , maxHeightUp : float , collisionNames : array <name >, out newPos : Vector ) : bool
Parameters:
componentName : name
maxHeightDown : float
maxHeightUp : float
collisionNames : array <name >
out newPos : Vector Returns:
bool Location:
starts @ line 417, ends @ line 458
Event Handlers
OnBehaviorGraphNotification
event OnBehaviorGraphNotification(notificationName : name , stateName : name )
Parameters:
notificationName : name
stateName : name Location:
starts @ line 96
OnCanBreakChildAttachment
event OnCanBreakChildAttachment(childEntity : CEntity)
Parameters:
childEntity : CEntity Location:
starts @ line 347
OnCanBreakParentAttachment
event OnCanBreakParentAttachment(parentEntity : CEntity)
Parameters:
parentEntity : CEntity Location:
starts @ line 344
OnCanCreateChildAttachment
event OnCanCreateChildAttachment(childEntity : CEntity)
Parameters:
childEntity : CEntity Location:
starts @ line 346
OnCanCreateParentAttachment
event OnCanCreateParentAttachment(parentEntity : CEntity)
Parameters:
parentEntity : CEntity Location:
starts @ line 343
OnChildAttachmentBroken
event OnChildAttachmentBroken(childEntity : CEntity)
Parameters:
childEntity : CEntity Location:
starts @ line 353
OnChildAttachmentCreated
event OnChildAttachmentCreated(childEntity : CEntity)
Parameters:
childEntity : CEntity Location:
starts @ line 352
OnParentAttachmentBroken
event OnParentAttachmentBroken(parentEntity : CEntity)
Parameters:
parentEntity : CEntity Location:
starts @ line 350
OnParentAttachmentCreated
event OnParentAttachmentCreated(parentEntity : CEntity)
Parameters:
parentEntity : CEntity Location:
starts @ line 349
OnSpawned
Uninteresting Sub-Classes These sub-classes have no public/protected members that are not overrides of their parent and have been merged here.
CBirdSpawnpoint
class CBirdSpawnpoint extends CEntity
Location:
/game/gameplay/animals/birdsManager.ws starts @ line 89, ends @ line 89
W3CurveFishSpawnpoint
class W3CurveFishSpawnpoint extends CEntity
Location:
/game/gameplay/animals/fishManager.ws starts @ line 120, ends @ line 120
