Struct ark_api::world::WorldData

pub struct WorldData { /* private fields */ }

Helper struct that represents a data object.

Implementations

impl WorldData

pub fn create(create_data_type: CreateDataType, input_data: &[u8]) -> Self

Creates a WorldData from the passed-in input data.

pub fn create_struct<T: Sized>(
    create_data_type: CreateDataType,
    input_data: &T
) -> Self

Creates a WorldData from the passed-in input data.

pub fn create_formatted_text(input_data: &str) -> Self

Creates a FormattedText object from the passed-in string.

pub fn create_render_module_data(
    module_dependency_name: &str,
    input_data: &[u8]
) -> Self

Creates a RenderModuleData object from the passed-in module dependency name and data.

pub fn create_audio_module_data(
    module_dependency_name: &str,
    input_data: &[u8]
) -> Self

Creates a AudioModuleData object from the passed-in module dependency name and data.

pub fn retrieve_data<T: Sized>(&self, t: RetrieveDataType) -> T

Gets different data from this data object.

pub fn data_type(&self) -> WorldDataType

Retrieves the internal data type of the WorldData instance.

pub fn get_data_handle(&self) -> DataHandle

Gets the DataHandle of this data object.

pub fn from_data_handle(handle: DataHandle) -> Self

Adopts a raw data handle and increases its ref count.

pub fn set_debug_name(&self, name: &str)

Sets a debug name of this data object. Useful for debugging memory usage and leaks.

pub fn debug_name(&self) -> String

Gets a debug name of this data object.

pub fn is_valid(&self) -> bool

Returns true if this is a valid data object. This should always be the case unless something has gone very wrong, such as the case where a user created this object from

Trait Implementations

impl Clone for WorldData

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorldData

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

Formats the value using the given formatter.

impl Drop for WorldData

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for WorldData

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<WorldData> for WorldData

fn eq(&self, other: &WorldData) -> 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 ValueConverterTrait<WorldData> for ValueConverter

fn into_value(v: WorldData) -> Value

Wraps the passed-in value in a Value enum.

fn from_value(v: &Value) -> WorldData

Extracts the value from a Value enum.

impl Eq for WorldData

impl StructuralEq for WorldData

impl StructuralPartialEq for WorldData