Struct bevy_script_api::common::bevy::ScriptWorld

pub struct ScriptWorld(_);

Implementations

impl ScriptWorld

pub fn new(ptr: WorldPointer) -> Self

pub fn get_children(&self, parent: Entity) -> Vec<Entity>

pub fn get_parent(&self, entity: Entity) -> Option<Entity>

pub fn push_child(&self, parent: Entity, child: Entity)

pub fn remove_children(&self, parent: Entity, children: &[Entity])

pub fn insert_children(&self, parent: Entity, index: usize, children: &[Entity])

pub fn despawn_children_recursive(&self, entity: Entity)

pub fn despawn_recursive(&self, entity: Entity)

pub fn get_type_by_name(&self, type_name: &str) -> Option<ScriptTypeRegistration>

pub fn add_default_component(
    &self,
    entity: Entity,
    comp_type: ScriptTypeRegistration
) -> Result<ScriptRef, ScriptError>

pub fn get_component(
    &self,
    entity: Entity,
    comp_type: ScriptTypeRegistration
) -> Result<Option<ScriptRef>, ScriptError>

pub fn has_component(
    &self,
    entity: Entity,
    comp_type: ScriptTypeRegistration
) -> Result<bool, ScriptError>

pub fn remove_component(
    &mut self,
    entity: Entity,
    comp_type: ScriptTypeRegistration
) -> Result<(), ScriptError>

pub fn get_resource(
    &self,
    res_type: ScriptTypeRegistration
) -> Result<Option<ScriptRef>, ScriptError>

pub fn has_resource(
    &self,
    res_type: ScriptTypeRegistration
) -> Result<bool, ScriptError>

pub fn remove_resource(
    &mut self,
    res_type: ScriptTypeRegistration
) -> Result<(), ScriptError>

Methods from Deref<Target = WorldPointer>

pub fn read(&self) -> MappedRwLockReadGuard<'_, RawRwLock, World>

Returns a read guard which can be used for immutable world access.

pub fn write(&self) -> MappedRwLockWriteGuard<'_, RawRwLock, World>

Returns a write guard which can be used for mutable world access.

Trait Implementations

impl AsRef<WorldPointer> for ScriptWorld

fn as_ref(&self) -> &WorldPointer

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ScriptWorld

fn clone(&self) -> ScriptWorld

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptWorld

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

Formats the value using the given formatter.

impl Deref for ScriptWorld

type Target = WorldPointer

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ScriptWorld

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for ScriptWorld

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

Formats the value using the given formatter.

impl From<ScriptWorld> for WorldPointer

fn from(val: ScriptWorld) -> Self

Converts to this type from the input type.