Difference between revisions of "EngagementControlExtended"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the EngagementControlExtended class)
(Documentation for the EngagementControlExtended class)
 
(4 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(who, identifier)}}
+
:{{CSharp|AbilityFired(ParticipantExtended who, string identifier)}}
 
::Parameters:
 
::Parameters:
−
:::{{CSharp|ParticipentExtended who}} : The participant who fires the ability
+
:::{{CSharp|who}} : The participant who fires the ability
−
:::{{CSharp|string identifier}} : The identifier of the ability being fired
+
:::{{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|string name}} : The name of the animation playing
+
:::{{CSharp|name}} : The name of the animation playing
−
:::{{CSharp|string layer}} : The layer on which the animation is playing
+
:::{{CSharp|layer}} : The layer on which the animation is playing
−
:::{{CSharp|bool looping}} : True if the animation will loop
+
:::{{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|string name}} : The name of the animation playing
+
:::{{CSharp|name}} : The name of the animation playing
−
:::{{CSharp|string layer}} : The layer on which the animation is playing
+
:::{{CSharp|layer}} : The layer on which the animation is playing
−
:::{{CSharp|bool looping}} : True if the animation will loop
+
:::{{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|string name}} : The name of the animation stopping
+
:::{{CSharp|name}} : The name of the animation stopping
−
:::{{CSharp|string layer}} : The layer on which the animation was playing
+
:::{{CSharp|layer}} : The layer on which the animation was playing
−
:::{{CSharp|bool looping}} : True if the animation was looping
+
:::{{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|long who}} : The ID of the controller of the player being added
+
:::{{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|long who}} : The ID of the controller of the player being removed
+
:::{{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|string identifier}} : The identifier of the new state
+
:::{{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|bool AddPlayer(IDOMObjectExtended player)}}
+
:{{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.
Line 73: Line 81:
 
::Disposes this engagement control.
 
::Disposes this engagement control.
  
−
:{{CSharp|bool IsPlayerEngaged(IDOMObjectExtended player)}}
+
:{{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|bool RemovePlayer(IDOMObjectExtended player, bool restoreAnimator {{=}} true)}}
+
:{{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.

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
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
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
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
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.
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.
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

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


Retrieved from "http://wiki.virtualworldweb.com/index.php?title=EngagementControlExtended&oldid=4698"