Warhorse ScripBind documentation
ContentsIndexHome
PreviousUpNext
C_PlayerStateHandlerScriptBind Methods

The methods of the C_PlayerStateHandlerScriptBind class are listed here.

 
Name 
Description 
 
Syntax: ChangeStance(Wuid stanceObject, string stance)
Executes the NPC state change request with the specified stance as the required state
 
 
Syntax: ChangeUnstance(Wuid unstanceObject, string unstance)
Executes the NPC state change request with the specified unstance as the required state. The unstanceObject may be invalid wuid for unstance without location object.
The script bind may contain optional parameters: string slaveLinkName
 
 
Syntax: ChangeUnstaceJoined(Wuid unstanceObject, string unstance, ScriptTable synchronizationData)
Executes the NPC state change request with the specified unstance as the requested state. The difference to previous script bind is that this one provides a way to executed joined unstance.
The script bind may contain optional parameter: string slaveLinkName
 
 
Syntax: EndHostResourcesPlayAnimationAction()
Ends hosting resources previously requested by HostResourcesPlayAnimationAction. It is not necessary to call this function if PlayAnimationAction is called.
 
 
Syntax: HostResourcesPlayAnimationAction(Wuid alignObject, string fragment, string tags, EntityId callbackEntityId, bool isHold)
Starts holding resources necessary for the PlayAnimationAction. Return true if hosting of resources is successfully attempted, returns false otherwise. If the resource hosting is started successfully the callback will be called. Either OnResourcesHosted is called if when the resources are hosted or OnResourcesTakenAway if there is a NPC with priority override. The callback may be called directly from within calling this scripting (if resources are hosted immediately)
The script bind may contain optional parameters: string slaveLinkName, string resourceOveride
 
 
Syntax: PlayAnimationAction(Wuid alignObject, string fragment, string tags, EntityId triggerEntityId, bool isHold)
Executes the NPC state change request with animation action as a extra action. The alignObject may be invalid wuid if the alignment and resource hosting is not required.
The script bind may contain optional parameters: string slaveLinkName, string resourceOveride, string triggerPointId, bool allowTorchForPlayer
 
 
Syntax: PlayAnimationAction(Wuid alignObject, string fragment, string tags, ScriptTable synchronizationData, EntityId triggerEntityId, bool isHold)
Executes the NPC state change request with animation action as a extra action. The animation action is synchronized according to the synchronization data. The alignObject may be invalid wuid if the alignment and resource hosting is not required.
The script bind may contain optional parameters: string slaveLinkName, string resourceOveride, string triggerPointId, bool allowTorchForPlayer
 
 
Syntax: StartMinigame(EntityId minigameObjectId, int minigameType, Wuid, resourceObjectId, string resourceName, int interruptUrgency)
Starts minigame after the resource is hosted by the player state handler. If defined by a link from resource object, an interrupt is scheduled to the blocking NPC using the specified urgency
 
Copyright (c) 2012. All rights reserved.