Skip to main content

Utw

rakata_generics::utw

Struct Utw

pub struct Utw {Show 17 fields
    pub template_resref: ResRef,
    pub tag: String,
    pub name: GffLocalizedString,
    pub appearance_id: u8,
    pub has_map_note: bool,
    pub map_note_enabled: bool,
    pub map_note: GffLocalizedString,
    pub palette_id: u8,
    pub comment: String,
    pub linked_to: String,
    pub description: GffLocalizedString,
    pub x_position: f32,
    pub y_position: f32,
    pub z_position: f32,
    pub x_orientation: f32,
    pub y_orientation: f32,
    pub z_orientation: f32,
}

Expand description

Typed UTW model built from/to Gff data.

Fields§

§template_resref: ResRef

Waypoint template resref (TemplateResRef).

§tag: String

Waypoint tag (Tag).

§name: GffLocalizedString

Localized waypoint name (LocalizedName).

§appearance_id: u8

Waypoint appearance id (Appearance).

§has_map_note: bool

Has-map-note flag (HasMapNote).

§map_note_enabled: bool

Map-note-enabled flag (MapNoteEnabled). Engine ignores this if has_map_note is false.

§map_note: GffLocalizedString

Localized map note (MapNote). Engine ignores this if has_map_note is false.

§palette_id: u8

Palette id (PaletteID).

§comment: String

Toolset comment (Comment).

§linked_to: String

Deprecated linked target (LinkedTo).

§description: GffLocalizedString

Deprecated localized description (Description).

§x_position: f32

World X position (XPosition).

§y_position: f32

World Y position (YPosition).

§z_position: f32

World Z position (ZPosition).

§x_orientation: f32

Facing X component (XOrientation). Engine will normalize the orientation vector at runtime if its magnitude is not 1.0.

§y_orientation: f32

Facing Y component (YOrientation). Engine will normalize the orientation vector at runtime if its magnitude is not 1.0.

§z_orientation: f32

Facing Z component (ZOrientation). Engine will normalize the orientation vector at runtime if its magnitude is not 1.0.

Implementations§

impl Utw

pub fn new() -> Self

Creates an empty UTW value.

pub fn from_gff(gff: &Gff) -> Result<Self, UtwError>

Builds typed UTW data from a parsed GFF container.

pub fn to_gff(&self) -> Gff

Converts this typed UTW value into a GFF container.

Trait Implementations§

impl Clone for Utw

fn clone(&self) -> Utw

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Utw

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

Formats the value using the given formatter. Read more

impl Default for Utw

fn default() -> Self

Returns the “default value” for a type. Read more

impl GffSchema for Utw

fn schema() -> &'static [FieldSchema]

Returns the root field schema for this GFF resource type.

impl PartialEq for Utw

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl StructuralPartialEq for Utw

Auto Trait Implementations§

impl Freeze for Utw

impl RefUnwindSafe for Utw

impl Send for Utw

impl Sync for Utw

impl Unpin for Utw

impl UnsafeUnpin for Utw

impl UnwindSafe for Utw

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T> StrictAs for T

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

fn strict_cast_from(src: Src) -> Dst

Casts the value.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.