Difference between revisions of "EngagementControlExtended"
From Virtual World Web Wiki
(Documentation for the EngagementControlExtended class) |
(Documentation for the EngagementControlExtended class) |
||
Line 44: | Line 44: | ||
===Methods=== | ===Methods=== | ||
− | :{{CSharp| | + | :{{CSharp|bool AddPlayer(IDOMObjectExtended player)}} |
:: | :: | ||
::Adds a player represented by the DOMObject to this engagement. | ::Adds a player represented by the DOMObject to this engagement. | ||
− | :{{CSharp| | + | :{{CSharp|void Close()}} |
:: | :: | ||
::Disposes this engagement control. | ::Disposes this engagement control. | ||
− | :{{CSharp| | + | :{{CSharp|bool IsPlayerEngaged(IDOMObjectExtended player)}} |
:: | :: | ||
::Tests if the player represented by the DOMObject is in this engagement. | ::Tests if the player represented by the DOMObject is in this engagement. | ||
− | :{{CSharp| | + | :{{CSharp|bool RemovePlayer(IDOMObjectExtended player, bool restoreAnimator)}} |
:: | :: | ||
::Removes a player represented by the DOMObject from this engagement. | ::Removes a player represented by the DOMObject from this engagement. | ||
− | :{{CSharp| | + | :{{CSharp|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. | ::Ask dirk. Looks like it sets the offset and rotation of the players from center of the target object of the engagement. | ||
− | :{{CSharp| | + | :{{CSharp|bool TransitionToState(string stateName)}} |
:: | :: | ||
::Transitions the engagement control into the requested state | ::Transitions the engagement control into the requested state | ||
− | :{{CSharp| | + | :{{CSharp|bool TriggerSkill(string skillname)}} |
:: | :: | ||
::Simulates the playing of the specified skill | ::Simulates the playing of the specified skill | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Revision as of 19:11, 3 February 2017
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>)
- Fired when a participant in an engagement uses one of their abilities
- AnimationLooped(EventHandler<FlexibleEventArgs>)
- Fired when an animation loops on this engagement
- AnimationStarted(EventHandler<FlexibleEventArgs>)
- Fired when an animation begins playing on this engagement
- AnimationStopped(EventHandler<FlexibleEventArgs>)
- Fired when an animation stops playing on this engagement
- PlayerAdded(EventHandler<FlexibleEventArgs>)
- 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>)
- 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>)
- 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)
- 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