-
Notifications
You must be signed in to change notification settings - Fork 82
Community goal event
Triggered when the status of a community goal changes.
When using this event in the Speech responder the information about this event is available under the event
object. The available variables are as follows
-
updates
a list of objects with sub-properties "type" (either "Tier" or "Percentile") and direction (either "Increase" or "Decrease") -
cgid
the unique id of the goal -
name
The description of the goal -
system
The star system where the goal is located -
station
The station where the goal is located -
expiry
The expiration time for the goal in seconds -
iscomplete
The completion status of the goal (true/false) -
total
The community's current total contributions -
contribution
The commander's contribution -
contributors
The number of commanders participating -
percentileband
the commander's current rewards percentile -
topranksize
The number of commanders in the top rank (only for goals with a fixed size top rank) -
toprank
Whether the commander is currently in the top rank (true/false) (only for goals with a fixed size top rank) -
tier
The current tier of the goal (only once the 1st tier is reached) -
tierreward
The reward on offer for the current tier -
toptier
The top tier of the goal -
toptierreward
The reward on offer for the top tier
To respond to this event in VoiceAttack, create a command entitled ((EDDI community goal)). The event information can be accessed using the following VoiceAttack variables
-
{DEC:EDDI community goal cgid}
the unique id of the goal -
{DEC:EDDI community goal contribution}
The commander's contribution -
{INT:EDDI community goal contributors}
The number of commanders participating -
{DEC:EDDI community goal expiry}
The expiration time for the goal in seconds -
{BOOL:EDDI community goal iscomplete}
The completion status of the goal (true/false) -
{TXT:EDDI community goal name}
The description of the goal -
{INT:EDDI community goal percentileband}
the commander's current rewards percentile -
{TXT:EDDI community goal station}
The station where the goal is located -
{TXT:EDDI community goal system}
The star system where the goal is located -
{INT:EDDI community goal tier}
The current tier of the goal (only once the 1st tier is reached) -
{DEC:EDDI community goal tierreward}
The reward on offer for the current tier -
{BOOL:EDDI community goal toprank}
Whether the commander is currently in the top rank (true/false) (only for goals with a fixed size top rank) -
{INT:EDDI community goal topranksize}
The number of commanders in the top rank (only for goals with a fixed size top rank) -
{INT:EDDI community goal toptier}
The top tier of the goal -
{TXT:EDDI community goal toptierreward}
The reward on offer for the top tier -
{DEC:EDDI community goal total}
The community's current total contributions
For more details on VoiceAttack integration, see https://github.com/EDCD/EDDI/wiki/VoiceAttack-Integration.