class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeCanvasItemControlBaseButtonButton OptionButton
A button that brings up a dropdown with selectable options when pressed.

OptionButton is a type of button that brings up a dropdown with selectable items when pressed. The item selected becomes the "current" item and is displayed as the button text.

See also BaseButton which contains common properties and methods associated with this node.

 item_focused item_focused<>( int index=, index:int=, ):item_focused

Emitted when the user navigates to an item using the ProjectSettings.input/ui_up or ProjectSettings.input/ui_down input actions. The index of the item selected is passed as argument.

 item_selected item_selected<>( int index=, index:int=, ):item_selected

Emitted when the current item has been changed by the user. The index of the item selected is passed as argument.

allow_reselect must be enabled to reselect an item.

 bool allow_reselect<>():bool

If true, the currently selected item can be selected again.

 bool fit_to_longest_item<>():bool

If true, minimum size will be determined by the longest item's text, instead of the currently selected one's.

Note: For performance reasons, the minimum size doesn't update immediately when adding, removing or modifying items.

 int item_count<>():int

The number of items to select from.

 int selected<>():int

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

 void add_icon_item<>( Texture2D texture=, texture:Texture2D=, String label=, label:String=, int=, int:=, ):void

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.

 void add_item<>( String label=, label:String=, int=, int:=, ):void

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.

 void add_separator<>( String text="", text:String="", ):void

Adds a separator to the list of items. Separators help to group items, and can optionally be given a text header. A separator also gets an index assigned, and is appended at the end of the item list.

 void clear<>():void

Clears all the items in the OptionButton.

 Texture2D get_item_icon<>( int idx=, idx:int=, ):Texture2D

Returns the icon of the item at index idx.

 int get_item_id<>( int idx=, idx:int=, ):int

Returns the ID of the item at index idx.

 int get_item_index<>( int id=, id:int=, ):int

Returns the index of the item with the given id.

 Variant get_item_metadata<>( int idx=, idx:int=, ):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.

 String get_item_text<>( int idx=, idx:int=, ):String

Returns the text of the item at index idx.

 String get_item_tooltip<>( int idx=, idx:int=, ):String

Returns the tooltip of the item at index idx.

 PopupMenu get_popup<>():PopupMenu

Returns the PopupMenu contained in this button.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their Window.visible property.

 int get_selectable_item<>( bool from_last=false, from_last:bool=false, ):int

Returns the index of the first item which is not disabled, or marked as a separator. If from_last is true, the items will be searched in reverse order.

Returns -1 if no item is found.

 int get_selected_id<>():int

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

 Variant get_selected_metadata<>():Variant

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

 bool has_selectable_items<>():bool

Returns true if this button contains at least one item which is not disabled, or marked as a separator.

 bool is_item_disabled<>( int idx=, idx:int=, ):bool

Returns true if the item at index idx is disabled.

 bool is_item_separator<>( int idx=, idx:int=, ):bool

Returns true if the item at index idx is marked as a separator.

 void remove_item<>( int idx=, idx:int=, ):void

Removes the item at index idx.

 void select<>( int idx=, idx:int=, ):void

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

Passing -1 as the index deselects any currently selected item.

 void set_disable_shortcuts<>( bool disabled=, disabled:bool=, ):void

If true, shortcuts are disabled and cannot be used to trigger the button.

 void set_item_disabled<>( int idx=, idx:int=, bool disabled=, disabled:bool=, ):void

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.

 void set_item_icon<>( int idx=, idx:int=, Texture2D texture=, texture:Texture2D=, ):void

Sets the icon of the item at index idx.

 void set_item_id<>( int idx=, idx:int=, int id=, id:int=, ):void

Sets the ID of the item at index idx.

 void set_item_metadata<>( int idx=, idx:int=, Variant metadata=, metadata:Variant=, ):void

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.

 void set_item_text<>( int idx=, idx:int=, String text=, text:String=, ):void

Sets the text of the item at index idx.

 void set_item_tooltip<>( int idx=, idx:int=, String tooltip=, tooltip:String=, ):void

Sets the tooltip of the item at index idx.

 void show_popup<>():void

Adjusts popup position and sizing for the OptionButton, then shows the PopupMenu. Prefer this over using get_popup().popup().


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...