Struct gdnative_doc::documentation::Property

pub struct Property {
    pub name: String,
    pub typ: Type,
    pub documentation: String,
}

Property exported to godot

Example

#[derive(NativeClass)]
#[inherit(Resource)]
struct MyResource {
    /// Some doc
    #[property]
    my_property: String,
}

Translates into:

name: "my_property",
typ: Type::Named("String"),
documentation: "Some doc"

Fields

name: String

Name of the property

typ: Type

Type of the property

documentation: String

Documentation associated with the property

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.

impl Eq for Property

impl Hash for Property

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Property> for Property

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Property

impl StructuralPartialEq for Property