EngagementControlExtended
From Virtual World Web Wiki
Revision as of 15:41, 21 February 2017 by Spark5 (Talk | contribs) (Documentation for the EngagementControlExtended class)
Represents an multiplayer engagement
- This is a JavaScript visible object
Remarks [edit]
Properties
- bool IsValid {get;}
- Ask dirk. Looks like it is.
- int NumParticipants {get;}
- Returns the number of participants in the engagement... except it doesn't. What is this?
Events
- AbilityFired(EventHandler<FlexibleEventArgs>)
- Param 'who' : The participant who fires the ability
- Param 'identifier' : The identifier of the ability being fired
- Fired when a participant in an engagement uses one of their abilities
- AnimationLooped(EventHandler<FlexibleEventArgs>)
- Param 'name' : The name of the animation playing
- Param 'layer' : The layer on which the animation is playing
- Param 'looping' : True if the animation will loop
- Fired when an animation loops on this engagement
- AnimationStarted(EventHandler<FlexibleEventArgs>)
- Param 'name' : The name of the animation playing
- Param 'layer' : The layer on which the animation is playing
- Param 'looping' : True if the animation will loop
- Fired when an animation begins playing on this engagement
- AnimationStopped(EventHandler<FlexibleEventArgs>)
- Param 'name' : The name of the animation stopping
- Param 'layer' : The layer on which the animation was playing
- Param 'looping' : True if the animation was looping
- Fired when an animation stops playing on this engagement
- PlayerAdded(EventHandler<FlexibleEventArgs>)
- Param 'who' : The ID of the controller of the player being added
- Fired when a new player is added to an engagement. ‘who’ is the ID of the controller of the new player, which may be a participant or a bot.
- PlayerRemoved(EventHandler<FlexibleEventArgs>)
- Param 'who' : The ID of the controller of the player being removed
- Fired when a new player is added to an engagement. ‘who’ is the ID of the controller of the new player, which may be a participant or a bot.
- StateChanged(EventHandler<FlexibleEventArgs>)
- Param 'identifier' : The identifier of the new state
- Fired when the state of the angagement changes, and passes in the new state identifier
Methods
- bool AddPlayer(IDOMObjectExtended player)
- Adds a player represented by the DOMObject to this engagement.
- void Close()
- Disposes this engagement control.
- bool IsPlayerEngaged(IDOMObjectExtended player)
- Tests if the player represented by the DOMObject is in this engagement.
- bool RemovePlayer(IDOMObjectExtended player, bool restoreAnimator = true)
- Removes a player represented by the DOMObject from this engagement.
- void SetOptions(JSVector3 position, JSVector3 rotation)
- Ask dirk. Looks like it sets the offset and rotation of the players from center of the target object of the engagement.
- bool TransitionToState(string stateName)
- Transitions the engagement control into the requested state
- bool TriggerSkill(string skillname)
- Simulates the playing of the specified skill