Difference between revisions of "EngagementControlExtended"
From Virtual World Web Wiki
(Documentation for the EngagementControlExtended class) |
(Documentation for the EngagementControlExtended class) |
||
(10 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:EngagementControlExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:EngagementControlExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
− | {{:EngagementControlExtended Remarks}} | + | {{#ifexist:EngagementControlExtended Remarks|{{:EngagementControlExtended Remarks}}|}} |
===Properties=== | ===Properties=== | ||
Line 13: | Line 13: | ||
:: | :: | ||
::Returns the number of participants in the engagement... except it doesn't. What is this? | ::Returns the number of participants in the engagement... except it doesn't. What is this? | ||
+ | |||
+ | :{{CSharp|string StartingState {get;} }} | ||
+ | :: | ||
+ | ::The State the Engagement started in | ||
+ | |||
+ | :{{CSharp|string State {get;} }} | ||
+ | :: | ||
+ | ::Current State of the Engagement | ||
===Events=== | ===Events=== | ||
− | :{{CSharp|AbilityFired( | + | :{{CSharp|AbilityFired(ParticipantExtended who, string identifier)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|who}} : The participant who fires the ability | ||
+ | :::{{CSharp|identifier}} : The identifier of the ability being fired | ||
:: | :: | ||
::Fired when a participant in an engagement uses one of their abilities | ::Fired when a participant in an engagement uses one of their abilities | ||
− | :{{CSharp|AnimationLooped( | + | :{{CSharp|AnimationLooped(string name, string layer, bool looping)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|name}} : The name of the animation playing | ||
+ | :::{{CSharp|layer}} : The layer on which the animation is playing | ||
+ | :::{{CSharp|looping}} : True if the animation will loop | ||
:: | :: | ||
::Fired when an animation loops on this engagement | ::Fired when an animation loops on this engagement | ||
− | :{{CSharp|AnimationStarted( | + | :{{CSharp|AnimationStarted(string name, string layer, bool looping)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|name}} : The name of the animation playing | ||
+ | :::{{CSharp|layer}} : The layer on which the animation is playing | ||
+ | :::{{CSharp|looping}} : True if the animation will loop | ||
:: | :: | ||
::Fired when an animation begins playing on this engagement | ::Fired when an animation begins playing on this engagement | ||
− | :{{CSharp|AnimationStopped( | + | :{{CSharp|AnimationStopped(string name, string layer, bool looping)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|name}} : The name of the animation stopping | ||
+ | :::{{CSharp|layer}} : The layer on which the animation was playing | ||
+ | :::{{CSharp|looping}} : True if the animation was looping | ||
:: | :: | ||
::Fired when an animation stops playing on this engagement | ::Fired when an animation stops playing on this engagement | ||
− | :{{CSharp|PlayerAdded( | + | :{{CSharp|PlayerAdded(long who)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|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. | ::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. | ||
− | :{{CSharp|PlayerRemoved( | + | :{{CSharp|PlayerRemoved(long who)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|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. | ::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. | ||
− | :{{CSharp|StateChanged( | + | :{{CSharp|StateChanged(string identifier)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|identifier}} : The identifier of the new state | ||
:: | :: | ||
::Fired when the state of the angagement changes, and passes in the new state identifier | ::Fired when the state of the angagement changes, and passes in the new state identifier | ||
===Methods=== | ===Methods=== | ||
− | :{{CSharp| | + | :{{CSharp|bool AddPlayer(DOMObjectExtended 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(DOMObjectExtended 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(DOMObjectExtended player, bool restoreAnimator {{=}} true)}} |
:: | :: | ||
::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__ |
Latest revision as of 20:56, 27 November 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?
- string StartingState {get;}
- The State the Engagement started in
- string State {get;}
- Current State of the Engagement
Events
- AbilityFired(ParticipantExtended who, string identifier)
- Parameters:
- who : The participant who fires the ability
- identifier : The identifier of the ability being fired
- Fired when a participant in an engagement uses one of their abilities
- Parameters:
- AnimationLooped(string name, string layer, bool looping)
- Parameters:
- name : The name of the animation playing
- layer : The layer on which the animation is playing
- looping : True if the animation will loop
- Fired when an animation loops on this engagement
- Parameters:
- AnimationStarted(string name, string layer, bool looping)
- Parameters:
- name : The name of the animation playing
- layer : The layer on which the animation is playing
- looping : True if the animation will loop
- Fired when an animation begins playing on this engagement
- Parameters:
- AnimationStopped(string name, string layer, bool looping)
- Parameters:
- name : The name of the animation stopping
- layer : The layer on which the animation was playing
- looping : True if the animation was looping
- Fired when an animation stops playing on this engagement
- Parameters:
- PlayerAdded(long who)
- Parameters:
- 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.
- Parameters:
- PlayerRemoved(long who)
- Parameters:
- 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.
- Parameters:
- StateChanged(string identifier)
- Parameters:
- identifier : The identifier of the new state
- Fired when the state of the angagement changes, and passes in the new state identifier
- Parameters:
Methods
- bool AddPlayer(DOMObjectExtended player)
- Adds a player represented by the DOMObject to this engagement.
- void Close()
- Disposes this engagement control.
- bool IsPlayerEngaged(DOMObjectExtended player)
- Tests if the player represented by the DOMObject is in this engagement.
- bool RemovePlayer(DOMObjectExtended 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