Difference between revisions of "EngagementControlExtended"
From Virtual World Web Wiki
(Documentation for the EngagementControlExtended class) |
(Documentation for the EngagementControlExtended class) |
||
Line 15: | Line 15: | ||
===Events=== | ===Events=== | ||
− | :{{CSharp|AbilityFired(who, identifier)}} | + | :{{CSharp|AbilityFired(ParticipantExtended who, string identifier)}} |
::Parameters: | ::Parameters: | ||
− | :::{{CSharp| | + | :::{{CSharp|who}} : The participant who fires the ability |
− | :::{{CSharp| | + | :::{{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(name, layer, looping)}} | + | :{{CSharp|AnimationLooped(string name, string layer, bool looping)}} |
::Parameters: | ::Parameters: | ||
− | :::{{CSharp| | + | :::{{CSharp|name}} : The name of the animation playing |
− | :::{{CSharp| | + | :::{{CSharp|layer}} : The layer on which the animation is playing |
− | :::{{CSharp| | + | :::{{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(name, layer, looping)}} | + | :{{CSharp|AnimationStarted(string name, string layer, bool looping)}} |
::Parameters: | ::Parameters: | ||
− | :::{{CSharp| | + | :::{{CSharp|name}} : The name of the animation playing |
− | :::{{CSharp| | + | :::{{CSharp|layer}} : The layer on which the animation is playing |
− | :::{{CSharp| | + | :::{{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(name, layer, looping)}} | + | :{{CSharp|AnimationStopped(string name, string layer, bool looping)}} |
::Parameters: | ::Parameters: | ||
− | :::{{CSharp| | + | :::{{CSharp|name}} : The name of the animation stopping |
− | :::{{CSharp| | + | :::{{CSharp|layer}} : The layer on which the animation was playing |
− | :::{{CSharp| | + | :::{{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(who)}} | + | :{{CSharp|PlayerAdded(long who)}} |
::Parameters: | ::Parameters: | ||
− | :::{{CSharp| | + | :::{{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(who)}} | + | :{{CSharp|PlayerRemoved(long who)}} |
::Parameters: | ::Parameters: | ||
− | :::{{CSharp| | + | :::{{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(identifier)}} | + | :{{CSharp|StateChanged(string identifier)}} |
::Parameters: | ::Parameters: | ||
− | :::{{CSharp| | + | :::{{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 |
Revision as of 15:06, 22 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(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(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