Class: FinalEvent

HungryGames~ FinalEvent


new FinalEvent(evt, game, affected)

Create an event ready for display.
Parameters:
Name Type Description
evt HungryGames~NormalEvent Event to finalize.
game HungryGames~GuildGame Game context.
affected Array.<HungryGames~Player> An array of all players affected by this event.
Source:

Members


attacker :Object

Information about the attackers as a result of this event. Weapon count is amount gained.
Type:
  • Object
Source:

consumer :string

The ID of the player that will be consuming weapons.
Type:
  • string
Source:

consumes :Array.<{name: string, count: number}>

Amount of weapons this consumes.
Type:
  • Array.<{name: string, count: number}>
Source:

icons :Array.<HungryGames~UserIconUrl>

The icons to show in the message.
Type:
Source:

mentionString :string

String to send to mention users.
Type:
  • string
Source:

message :string

Message to show to user.
Type:
  • string
Source:

subMessage :string

Additional message text to display.
Type:
  • string
Source:

victim :Object

Information about the victims as a result of this event. Weapon count is amount gained.
Type:
  • Object
Source: