Messages

Similar to Components, Messages are collections of data. Message prototypes are defined by their inherited prototype and their required and optional fields, which are used to instantiate the Messages themselves. See the Field Type Reference for a list of valid field types.

Messages are used to send data to Engines so they can manipulate the game state accordingly.

Unlike Components, Messages are temporary and destroyed at the end of each frame.

For performance reasons, it is discouraged to create new tables to pass to messages, as this will cause garbage collection issues.

Defining any logic on a Message is an anti-pattern. Messages should not need to directly trigger any side-effects. Do not do this.

• ComponentMessage
  • Function Reference
• EntityMessage
  • Function Reference
• SpawnMessage
  • Function Reference
• StateMessage
  • Function Reference
• SideEffectMessage
  • Function Reference