Struct gdnative::VariantArray

pub struct VariantArray(_);

A reference-counted Variant vector. Godot's generic array data type. Negative indices can be used to count from the right.

Methods

impl VariantArray

pub fn new() -> Self

Creates an empty VariantArray.

pub fn set(&mut self, idx: i32, val: &Variant)

Sets the value of the element at the given offset.

pub fn get_val(&mut self, idx: i32) -> Variant

Returns a copy of the element at the given offset.

pub fn get_ref(&self, idx: i32) -> &Variant

Returns a reference to the element at the given offset.

pub fn get_mut_ref(&mut self, idx: i32) -> &mut Variant

Returns a mutable reference to the element at the given offset.

pub fn count(&mut self, val: &Variant) -> i32

pub fn clear(&mut self)

Clears the array, resizing to 0.

pub fn remove(&mut self, idx: i32)

pub fn erase(&mut self, val: &Variant)

pub fn is_empty(&self) -> bool

Returns true if the VariantArray contains no elements.

pub fn len(&self) -> i32

Returns the number of elements in the array.

pub fn push(&mut self, val: &Variant)

Appends an element at the end of the array.

pub fn pop(&mut self) -> Variant

Removes an element at the end of the array.

pub fn push_front(&mut self, val: &Variant)

Appends an element to the front of the array.

pub fn pop_front(&mut self) -> Variant

Removes an element at the front of the array.

pub fn insert(&mut self, at: i32, val: &Variant)

Insert a new int at a given position in the array.

pub fn find(&self, what: &Variant, from: i32) -> i32

Searches the array for a value and returns its index. Pass an initial search index as the second argument. Returns -1 if value is not found.

pub fn contains(&self, what: &Variant) -> bool

Returns true if the VariantArray contains the specified value.

pub fn resize(&mut self, size: i32)

pub fn rfind(&self, what: &Variant, from: i32) -> i32

Searches the array in reverse order. Pass an initial search index as the second argument. If negative, the start index is considered relative to the end of the array.

pub fn find_last(&self, what: &Variant) -> i32

Searches the array in reverse order for a value. Returns its index or -1 if not found.

pub fn invert(&mut self)

Inverts the order of the elements in the array.

pub fn hash(&self) -> i32

Return a hashed i32 value representing the array contents.

pub fn sort(&mut self)

pub fn new_ref(&self) -> VariantArray

Trait Implementations

impl<'l> From<&'l VariantArray> for Variant

fn from(val: &'l VariantArray) -> Variant

Performs the conversion.

impl Drop for VariantArray

fn drop(&mut self)

Executes the destructor for this type.

impl Default for VariantArray

fn default() -> Self

Returns the "default value" for a type.

impl GodotType for VariantArray

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Self>

fn from_sys_variant(variant: &godot_variant) -> Option<Self>