AbilityExtended

From Virtual World Web Wiki
Jump to: navigation, search

Represents a user ability

  • This is a JavaScript visible object

Remarks [edit]

Properties

bool Active {get; set;}
Marks an ability as active (in use). This is meant mainly for display purposes.
float Cooldown {get;}
True if the ability or any of it’s parents are denied. Setting this value may have no effect until parents are un-denied (allowed).
float CooldownProgress {get;}
A number between 0 and 1 representing the percentage of cooldown time elapsed since the ability was last set Active.
bool Denied {get; set;}
True if the ability or any of it’s parents are denied. Setting this value may have no effect until parents are un-denied (allowed).
string Description {get;}
The description of the ability (not currently used)
bool Enabled {get; set;}
True if the ability is currently enabled. Note that setting an ability to enabled will make the change locally, but may not take effect if the ability is denied, or any of it’s parents are disabled or denied.
string ID {get;}
The unique ID of the ability
string Identifier {get;}
The translatable identifier of the ability
string Metadata {get;}
The JSON metadata associated with the ability
bool ScriptCreated {get;}
True if the Ability or AbilityGroup was created by javascript.

Methods

void Remove()
Removes the ability.
void Reset()
Attempts to reset the ability (Enabled, not Denied, not Active)