Struct ambient_api::core::package::concepts::Package

pub struct Package {
    pub is_package: (),
    pub enabled: bool,
    pub id: String,
    pub name: String,
    pub version: String,
    pub authors: Vec<String>,
    pub asset_url: String,
    pub client_modules: Vec<EntityId>,
    pub server_modules: Vec<EntityId>,
    pub optional: PackageOptional,
}

Package: A package is a collection of assets, definitions and WASM logic.

Required:

• is_package: Whether or not this entity is a package.
• enabled: Whether or not this package is enabled.
• id: The ID of the package.
• name: The name of the package.
• version: The version of the package.
• authors: The authors of the package.
• asset_url: The asset URL (i.e. where the built assets are) of the package.
• client_modules: The clientside WASM modules spawned by this package.
• server_modules: The serverside WASM modules spawned by this package.

Optional:

• description: The description of the package. If not attached, the package does not have a description.
• repository: The repository of the package. If not attached, the package does not have a repository.
• for_playables: The playable IDs that this package is for. This package must be a Mod.

Fields

is_package: ()

Component: ambient_core::package::is_package

Component description: Whether or not this entity is a package.

enabled: bool

Component: ambient_core::package::enabled

Component description: Whether or not this package is enabled.

id: String

Component: ambient_core::package::id

Component description: The ID of the package.

name: String

Component: ambient_core::package::name

Component description: The name of the package.

version: String

Component: ambient_core::package::version

Component description: The version of the package.

authors: Vec<String>

Component: ambient_core::package::authors

Component description: The authors of the package.

asset_url: String

Component: ambient_core::package::asset_url

Component description: The asset URL (i.e. where the built assets are) of the package.

client_modules: Vec<EntityId>

Component: ambient_core::package::client_modules

Component description: The clientside WASM modules spawned by this package.

server_modules: Vec<EntityId>

Component: ambient_core::package::server_modules

Component description: The serverside WASM modules spawned by this package.

optional: PackageOptional

Optional components.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Concept for Package

fn make(self) -> Entity

Creates an entity with the components defined by this concept.

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

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<Package>

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 Package

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

A tuple of the required components for this concept.

type Optional = (Component<String>, Component<String>, Component<Vec<String>>)

A tuple of the optional components for this concept.

fn required() -> <Package as ConceptComponents>::Required

Returns a tuple of the required components for this concept.

fn optional() -> <Package as ConceptComponents>::Optional

Returns a tuple of the optional components for this concept.

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

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 Package

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Package

fn deserialize<__D>( __deserializer: __D ) -> Result<Package, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Package

fn eq(&self, other: &Package) -> 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 Package

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Package