Struct gdnative_bindings_lily::OptionButton

pub struct OptionButton { /* fields omitted */ }

core class OptionButton inherits Button (unsafe).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

OptionButton is a reference-only type. Persistent references can only exist in the unsafe Ref<OptionButton> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

OptionButton inherits methods from:

• Button
• BaseButton
• Control
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have “interior mutability” in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl OptionButton

pub fn new() -> Ref<Self, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn add_icon_item(
    &self,
    texture: impl AsArg<Texture>,
    label: impl Into<GodotString>,
    id: i64
)

Adds an item, with a texture icon, text label and (optionally) id. If no id is passed, the item index will be used as the item’s ID. New items are appended at the end.

Default Arguments

• id - -1

pub fn add_item(&self, label: impl Into<GodotString>, id: i64)

Adds an item, with text label and (optionally) id. If no id is passed, the item index will be used as the item’s ID. New items are appended at the end.

Default Arguments

• id - -1

pub fn add_separator(&self)

Adds a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end.

pub fn clear(&self)

Clears all the items in the OptionButton.

pub fn get_item_count(&self) -> i64

Returns the amount of items in the OptionButton, including separators.

pub fn get_item_icon(&self, idx: i64) -> Option<Ref<Texture, Shared>>

Returns the icon of the item at index idx.

pub fn get_item_id(&self, idx: i64) -> i64

Returns the ID of the item at index idx.

pub fn get_item_index(&self, id: i64) -> i64

Returns the index of the item with the given id.

pub fn get_item_metadata(&self, idx: i64) -> Variant

Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID.

pub fn get_item_text(&self, idx: i64) -> GodotString

Returns the text of the item at index idx.

pub fn get_popup(&self) -> Option<Ref<PopupMenu, Shared>>

Returns the PopupMenu contained in this button.

pub fn selected(&self) -> i64

The index of the currently selected item, or -1 if no item is selected.

pub fn get_selected_id(&self) -> i64

Returns the ID of the selected item, or 0 if no item is selected.

pub fn get_selected_metadata(&self) -> Variant

Gets the metadata of the selected item. Metadata for items can be set using [method set_item_metadata].

pub fn is_item_disabled(&self, idx: i64) -> bool

Returns true if the item at index idx is disabled.

pub fn remove_item(&self, idx: i64)

Removes the item at index idx.

pub fn select(&self, idx: i64)

Selects an item by index and makes it the current item. This will work even if the item is disabled.

pub fn set_item_disabled(&self, idx: i64, disabled: bool)

Sets whether the item at index idx is disabled. Disabled items are drawn differently in the dropdown and are not selectable by the user. If the current selected item is set as disabled, it will remain selected.

pub fn set_item_icon(&self, idx: i64, texture: impl AsArg<Texture>)

Sets the icon of the item at index idx.

pub fn set_item_id(&self, idx: i64, id: i64)

Sets the ID of the item at index idx.

pub fn set_item_metadata(&self, idx: i64, metadata: impl OwnedToVariant)

Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID.

pub fn set_item_text(&self, idx: i64, text: impl Into<GodotString>)

Sets the text of the item at index idx.

Methods from Deref<Target = Button>

pub const ALIGN_CENTER: i64

pub const ALIGN_LEFT: i64

pub const ALIGN_RIGHT: i64

pub fn button_icon(&self) -> Option<Ref<Texture, Shared>>

Button’s icon, if text is present the icon will be placed before the text.

pub fn clip_text(&self) -> bool

When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.

pub fn text(&self) -> GodotString

The button’s text that will be displayed inside the button’s area.

pub fn text_align(&self) -> TextAlign

Text alignment policy for the button’s text, use one of the [enum TextAlign] constants.

pub fn is_expand_icon(&self) -> bool

When enabled, the button’s icon will expand/shrink to fit the button’s size while keeping its aspect.

pub fn is_flat(&self) -> bool

Flat buttons don’t display decoration.

pub fn set_button_icon(&self, texture: impl AsArg<Texture>)

Button’s icon, if text is present the icon will be placed before the text.

pub fn set_clip_text(&self, enabled: bool)

When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.

pub fn set_expand_icon(&self, arg0: bool)

When enabled, the button’s icon will expand/shrink to fit the button’s size while keeping its aspect.

pub fn set_flat(&self, enabled: bool)

Flat buttons don’t display decoration.

pub fn set_text(&self, text: impl Into<GodotString>)

The button’s text that will be displayed inside the button’s area.

pub fn set_text_align(&self, align: i64)

Text alignment policy for the button’s text, use one of the [enum TextAlign] constants.

Trait Implementations

impl Debug for OptionButton

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

Formats the value using the given formatter.

impl Deref for OptionButton

type Target = Button

The resulting type after dereferencing.

fn deref(&self) -> &Button

Dereferences the value.

impl DerefMut for OptionButton

fn deref_mut(&mut self) -> &mut Button

Mutably dereferences the value.

impl GodotObject for OptionButton

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for OptionButton

fn construct() -> Ref<Self, Unique>

impl QueueFree for OptionButton

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for OptionButton

impl SubClass<BaseButton> for OptionButton

impl SubClass<Button> for OptionButton

impl SubClass<CanvasItem> for OptionButton

impl SubClass<Control> for OptionButton

impl SubClass<Node> for OptionButton

impl SubClass<Object> for OptionButton