Struct ambient_api_core::core::wasm::concepts::Module

pub struct Module {
    pub is_module: (),
    pub bytecode_from_url: String,
    pub module_enabled: bool,
    pub module_name: String,
    pub package_ref: EntityId,
    pub optional: ModuleOptional,
}

Module: A WASM module that can be enabled or disabled, and may or may not be on the server.

Required:

• is_module: A module.
• bytecode_from_url: Asset URL for the bytecode of a WASM component.
• module_enabled: Whether or not this module is enabled.
• module_name: The name of this module.
• package_ref: The package that this module belongs to.

Optional:

• is_module_on_server: Whether or not this module is on the server.

Fields

is_module: ()

Component: ambient_core::wasm::is_module

Component description: A module.

bytecode_from_url: String

Component: ambient_core::wasm::bytecode_from_url

Component description: Asset URL for the bytecode of a WASM component.

module_enabled: bool

Component: ambient_core::wasm::module_enabled

Component description: Whether or not this module is enabled.

module_name: String

Component: ambient_core::wasm::module_name

Component description: The name of this module.

package_ref: EntityId

Component: ambient_core::wasm::package_ref

Component description: The package that this module belongs to.

optional: ModuleOptional

Optional components.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Concept for Module

fn make(self) -> Entity

Creates an entity with the components defined by this concept.

fn get_spawned(id: EntityId) -> Option<Self>

If the entity with id exists and has the components defined by this concept, returns this concept with all of the values of the components in the entity.

fn get_unspawned(entity: &Entity) -> Option<Self>

If the entity has the components defined by this concept, returns this concept with all of the values of the components in the entity.

fn contained_by_spawned(id: EntityId) -> bool

Returns true if id exists and contains the components defined by this concept.

fn contained_by_unspawned(entity: &Entity) -> bool

Returns true if contains the components defined by this concept.

fn spawn(self) -> EntityId

where Self: Sized,

Spawns this concept into the world. If you want to modify state before spawning, use make instead.

impl ConceptComponents for Module

type Required = (Component<()>, Component<String>, Component<bool>, Component<String>, Component<EntityId>)

A tuple of the required components for this concept.

type Optional = (Component<()>,)

A tuple of the optional components for this concept.

fn required() -> Self::Required

Returns a tuple of the required components for this concept.

fn optional() -> Self::Optional

Returns a tuple of the optional components for this concept.

fn from_required_data( required: <Self::Required as ComponentsTuple>::Data ) -> Self

Converts a tuple of data back to a concept.

fn as_query() -> ConceptQuery<Self>

where Self: Sized,

Creates a ConceptQuery that can be passed into queries.

impl Debug for Module

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Module

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Module

fn eq(&self, other: &Module) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Module

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Module