Struct godot::meta::PropertyHintInfo

pub struct PropertyHintInfo {
    pub hint: PropertyHint,
    pub hint_string: GString,
}

Info needed by Godot, for how to export a type to the editor.

Fields

hint: PropertyHint

hint_string: GString

Implementations

impl PropertyHintInfo

pub fn none() -> PropertyHintInfo

Create a new PropertyHintInfo with a property hint of PROPERTY_HINT_NONE, and no hint string.

pub fn type_name<T>() -> PropertyHintInfo

where T: GodotType,

Use PROPERTY_HINT_NONE with T’s Godot type name.

Starting with Godot version 4.3, the hint string will always be the empty string. Before that, the hint string is set to be the Godot type name of T.

pub fn var_array_element<T>() -> PropertyHintInfo

where T: ArrayElement,

Use for #[var] properties – PROPERTY_HINT_ARRAY_TYPE with the type name as hint string.

pub fn export_array_element<T>() -> PropertyHintInfo

where T: ArrayElement,

Use for #[export] properties – PROPERTY_HINT_TYPE_STRING with the element type string as hint string.

pub fn export_packed_array_element<T>() -> PropertyHintInfo

where T: PackedArrayElement,

Use for #[export] properties – PROPERTY_HINT_TYPE_STRING with the element type string as hint string.

Trait Implementations

impl Clone for PropertyHintInfo

fn clone(&self) -> PropertyHintInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyHintInfo

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

Formats the value using the given formatter.

impl PartialEq for PropertyHintInfo

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

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

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 Eq for PropertyHintInfo

impl StructuralPartialEq for PropertyHintInfo