Struct amethyst_ui::Selectable

pub struct Selectable<G> {
    pub order: u32,
    pub multi_select_group: Option<G>,
    pub auto_multi_select: bool,
    pub consumes_inputs: bool,
}

Component indicating that a Ui entity is selectable. Generic Type:

• G: Selection Group. Used to determine which entities can be selected together at the same time.

Fields

order: u32

The order in which entities are selected when pressing the Tab key or the "go to next" input action.

multi_select_group: Option<G>

A multi selection group. When multiple entities are in the same selection group, they can be selected at the same time by holding shift or control and clicking them. You can also select the first element, then hold shift and press the keyboard arrow keys.

auto_multi_select: bool

Indicates if you can select multiple entities at once without having to press the shift or control key.

consumes_inputs: bool

Indicates if this consumes the inputs. If enabled, all inputs (except Tab) will be ignored when the component is focused. For example, the arrow keys will not change the selected ui element. Example usage: Ui Editable Text.

Methods

impl<G> Selectable<G>

pub fn new(order: u32) -> Self

Constructs a new Selectable.

Trait Implementations

impl<G: Debug> Debug for Selectable<G>

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

Formats the value using the given formatter.

impl<G> Serialize for Selectable<G> where
    G: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, G> Deserialize<'de> for Selectable<G> where
    G: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<G: Send + Sync + 'static> Component for Selectable<G>

type Storage = FlaggedStorage<Self, DenseVecStorage<Self>>

Associated storage type for this component.