Enum bevy_mod_scripting::lua::api::bevy::LuaMat2

pub enum LuaMat2 {
    Owned(UnsafeCell<Mat2>, Arc<RwLock<RawRwLock, ()>>),
    Ref(ScriptRef),
}

A script wrapper for the type Mat2

Variants

Owned(UnsafeCell<Mat2>, Arc<RwLock<RawRwLock, ()>>)

Ref(ScriptRef)

Implementations

impl LuaMat2

pub fn script_ref(&self, world_ptr: WorldPointer) -> ScriptRef

Creates a script reference pointing to the wrapped value.

Depending on this value it may be a lua owned or reflect relative reference

pub fn new(b: Mat2) -> LuaMat2

pub fn new_ref(b: ScriptRef) -> LuaMat2

pub fn val<G, F>(&self, accessor: F) -> Result<G, ReflectionError>where F: FnOnce(&Mat2) -> G,

Perform an operation on the base type and optionally retrieve something by value may require a read lock on the world in case this is a reference

pub fn val_mut<G, F>(&mut self, accessor: F) -> Result<G, ReflectionError>where F: FnOnce(&mut Mat2) -> G,

pub fn apply_self_to_base( &self, other: &mut ScriptRef ) -> Result<(), ReflectionError>

Applies Self to another ScriptRef. may require a write lock on the world

pub fn inner(&self) -> Result<Mat2, ReflectionError>where Mat2: Clone,

retrieves the underlying value by cloning it

Trait Implementations

impl Clone for LuaMat2

fn clone(&self) -> LuaMat2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LuaMat2

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

Formats the value using the given formatter.

impl Drop for LuaMat2

fn drop(&mut self)

Executes the destructor for this type.

impl TealData for LuaMat2

fn add_methods<'lua, T>(methods: &mut T)where T: TealDataMethods<'lua, LuaMat2>,

same as UserData::add_methods. Refer to its documentation on how to use it.

fn add_fields<'lua, T>(fields: &mut T)where T: TealDataFields<'lua, LuaMat2>,

same as UserData::add_fields. Refer to its documentation on how to use it.

impl TypeBody for LuaMat2

fn get_type_body() -> TypeGenerator

Fills in the TypeGenerator so a .d.tl file can be constructed.

impl TypeName for LuaMat2

fn get_type_parts() -> Cow<'static, [NamePart]>

returns the type name as how it should show up in the generated .d.tl file

fn get_type_parts_as_global() -> Cow<'static, [NamePart]>

Generates the typename when used to describe a global value.

fn get_type_kind() -> KindOfType

This method tells the generator if this type is builtin to teal/lua, if it comes from somewhere else or if it stands in as a generic

fn collect_children(_: &mut Vec<TealType, Global>)

Creates/updates a list of every child type this type has This is used to properly label methods/functions as being generic.

impl UserData for LuaMat2

fn add_fields<'lua, F>(fields: &mut F)where F: UserDataFields<'lua, LuaMat2>,

Adds custom fields specific to this userdata.

fn add_methods<'lua, M>(methods: &mut M)where M: UserDataMethods<'lua, LuaMat2>,

Adds custom methods and operators specific to this userdata.

impl Sync for LuaMat2

Safety: we make this sync via RwLock<()> assuming invariants are upheld