Skip to content

Community goal event

Jump to bottom
Tkael edited this page Jun 20, 2021 · 10 revisions

Triggered when the status of a community goal changes.

Where values are indexed (the compartments on a ship for example), the index will be represented by '<index>'. For VoiceAttack, a variable with the root name of the indexed array shall identify the total number of entries in the array. For example, if compartments 1 and 2 are available then the value of the corresponding 'compartments' variable will be 2.

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:

  • {event.cgid} - The unique id of the goal

  • {event.contribution} - The commander's contribution

  • {event.contributors} - The number of commanders participating

  • {event.expiry} - The expiration time for the goal in seconds

  • {event.iscomplete} - The completion status of the goal (true/false)

  • {event.name} - The description of the goal

  • {event.percentileband} - the commander's current rewards percentile

  • {event.station} - The station where the goal is located

  • {event.system} - The star system where the goal is located

  • {event.tier} - The current tier of the goal (only once the 1st tier is reached)

  • {event.tierreward} - The reward on offer for the current tier

  • {event.toprank} - Whether the commander is currently in the top rank (true/false) (only for goals with a fixed size top rank)

  • {event.topranksize} - The number of commanders in the top rank (only for goals with a fixed size top rank)

  • {event.toptier} - The top tier of the goal

  • {event.toptierreward} - The reward on offer for the top tier

  • {event.total} - The community's current total contributions

  • {event.updates} - The updates that triggered the event (as objects)

  • {event.updates[<index>].direction}

  • {event.updates[<index>].type}

To respond to this event in VoiceAttack, create a command entitled ((EDDI community goal)). VoiceAttack variables will be generated to allow you to access the event information.

The following VoiceAttack variables are available for this event:

  • {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

  • {INT:EDDI community goal updates} - The updates that triggered the event (as objects)

  • {TXT:EDDI community goal updates <index> direction}

  • {TXT:EDDI community goal updates <index> type}

For more details on VoiceAttack integration, see https://github.com/EDCD/EDDI/wiki/VoiceAttack-Integration.

Clone this wiki locally