Module fyrox::script

Script is used to add custom logic to scene nodes. See ScriptTrait for more info.

Modules

• constructor
  A special container that is able to create nodes by their type UUID.

Structs

• PluginsRefMut
  A simple wrapper for a reference to plugins container. It has some useful methods to fetch a plugin of certain type. See PluginsRefMut::of_type_ref and PluginsRefMut::of_type_mut.
• Script
  A wrapper for actual script instance internals, it used by the engine.
• ScriptContext
  A set of data, that provides contextual information for script methods.
• ScriptDeinitContext
  A set of data that will be passed to a script instance just before its destruction.
• ScriptMessage
  A script message of a particular kind.
• ScriptMessageContext
  A set of data, that provides contextual information for script methods.
• ScriptMessageSender
  A script message sender.

Enums

• RoutingStrategy
  Defines how a script message will be delivered for each node in a hierarchy.
• ScriptMessageKind
  An message for a node with a script.

Traits

• BaseScript
  Base script trait is used to automatically implement some trait to reduce amount of boilerplate code.
• ScriptMessagePayload
  A script message’s payload.
• ScriptTrait
  Script is a set predefined methods that are called on various stages by the engine. It is used to add custom behaviour to game entities.