Class: ForcedOutcome

HungryGames~ ForcedOutcome


new ForcedOutcome(id, list, state, text [, persists])

Create a single forced outcome.
Parameters:
Name Type Argument Default Description
id string The guild ID in which the users will be affected.
list Array.<string> The array of player IDs of which to affect.
state string The outcome to force the players to have been victims of by the end of the simulated day. ("living", "dead", "wounded", or "thriving").
text string Message to show when the user is affected.
persists boolean <optional>
false Does this outcome persist to the end of the game, if false it only exists for the next day.
Source:

Members


id :string

The guild ID of which the users will be affected.
Type:
  • string
Source:

list :Array.<string>

The array of player IDs of which this concerns.
Type:
  • Array.<string>
Source:

persists :boolean

Does this outcome persist to the end of the game. False to only exist for a single day.
Type:
  • boolean
Default Value:
  • false
Source:

state :string

The state to force the players to be in.
Type:
  • string
Source:

text :string

Message to show when the user is affected.
Type:
  • string
Source: