Difference between revisions of "EngagementControlExtended"

Revision as of 15:26, 18 November 2016

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

ReturnType AddPlayer(IDOMObjectExtended player)

Adds a player represented by the DOMObject to this engagement.

ReturnType Close()

Disposes this engagement control.

ReturnType IsPlayerEngaged(IDOMObjectExtended player)

Tests if the player represented by the DOMObject is in this engagement.

ReturnType RemovePlayer(IDOMObjectExtended player, bool restoreAnimator)

Removes a player represented by the DOMObject from this engagement.

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

ReturnType TransitionToState(string stateName)

Transitions the engagement control into the requested state

ReturnType TriggerSkill(string skillname)

Simulates the playing of the specified skill