API docs
System

System

Mojo trait 🡭

System

Trait for systems in the scheduler.

Aliases

  • __del__is_trivial = : A flag (often compiler generated) to indicate whether the implementation of __del__ is trivial. The implementation of __del__ is considered to be trivial if:
  • The struct has a compiler-generated trivial destructor and all its fields have a trivial __del__ method.

In practice, it means that the __del__ can be considered as no-op.

  • __copyinit__is_trivial = : A flag (often compiler generated) to indicate whether the implementation of __copyinit__ is trivial. The implementation of __copyinit__ is considered to be trivial if:
  • The struct has a compiler-generated trivial __copyinit__ and all its fields have a trivial __copyinit__ method.

In practice, it means the value can be copied by copying the bits from one location to another without side effects.

  • __moveinit__is_trivial = : A flag (often compiler generated) to indicate whether the implementation of __moveinit__ is trivial. The implementation of __moveinit__ is considered to be trivial if:
  • The struct has a compiler-generated __moveinit__ and all its fields have a trivial __moveinit__ method.

In practice, it means the value can be moved by moving the bits from one location to another without side effects.

Implemented traits

AnyType, Copyable, Movable, UnknownDestructibility

Methods

Expand all   Collapse all

__copyinit__ 

@staticmethod
fn __copyinit__(out self: _Self, existing: _Self, /)

Create a new instance of the value by copying an existing one. Args:

  • existing (_Self): The value to copy.
  • self (_Self)

Returns:

_Self

__moveinit__ 

@staticmethod
fn __moveinit__(out self: _Self, var existing: _Self, /)

Create a new instance of the value by moving the value of another. Args:

  • existing (_Self): The value to move.
  • self (_Self)

Returns:

_Self

initialize 

fn initialize(mut self: _Self, mut world: World[component_types])

Initializes the system with the given world. Args:

  • self (_Self)
  • world (World): The world to use for initialization.

Raises:

update 

fn update(mut self: _Self, mut world: World[component_types])

Updates the system with the given world. Args:

  • self (_Self)
  • world (World): The world to use for the update.

Raises:

finalize 

fn finalize(mut self: _Self, mut world: World[component_types])

Finalizes the system with the given world. Args:

  • self (_Self)
  • world (World): The world to use for the finalization.

Raises:

copy 

fn copy(self: _Self) -> _Self

Explicitly construct a copy of self. Args:

  • self (_Self)

Returns:

_Self: A copy of this value.

SchedulerWorld