Skip to main content

OptionSelect

Struct OptionSelect 

Source
pub struct OptionSelect {
Show 14 fields pub setting: String, pub label: String, pub x: f32, pub y: f32, pub width: f32, pub height: f32, pub font: String, pub font_px: f32, pub text_color: [f32; 3], pub value_color: [f32; 3], pub text_scale: f32, pub hover_color: [f32; 3], pub hover_scale: f32, pub stepper_width: f32,
}
Expand description

A settings row that cycles through a fixed set of values on click.

OptionSelect is a build-time shorthand for one row of a settings menu: a left-aligned name, a right-aligned current value, and a clickable region that advances the value. It expands into a TextLabel for the name, a TextLabel for the value, and a HitRegion that fires a "setting:<setting>:next" action.

The setting field names an engine setting the runtime knows how to read, cycle, and apply (e.g. "vsync"); its option list lives in the engine, not here. The value label shows a placeholder at build time and is corrected to the live value when the world starts.

Generated names are prefixed with this asset’s name (<name>_label, <name>_value, <name>_btn), so they never clash with hand-authored assets.

OptionSelect {
    setting: "vsync".into(),
    label: "Vsync".into(),
    ..Default::default()
};

Fields§

§setting: String

Engine setting this row controls (e.g. "vsync"). Must be a setting the runtime recognises; an unknown key renders but does nothing on click.

§label: String

Display name shown at the left of the row.

§x: f32

Left edge of the row in window pixels.

§y: f32

Top edge of the row in window pixels.

§width: f32

Row width in window pixels (name sits at the left, value at the right).

§height: f32

Row height in window pixels (the clickable region’s height).

§font: String

Font for the row text. Empty uses the built-in font.

§font_px: f32

Pixel size of the row text when it uses the built-in font (that is, when font is empty). Ignored when font names a Font, which carries its own size.

§text_color: [f32; 3]

Linear-space RGB color of the name text.

§value_color: [f32; 3]

Linear-space RGB color of the value text.

§text_scale: f32

Scale applied to the row text.

§hover_color: [f32; 3]

RGB color of the value text while the row is hovered.

§hover_scale: f32

Scale of the value text while the row is hovered.

§stepper_width: f32

Width in pixels of the < previous-value click region. The > next-value region spans the rest of the row’s right half (the value sits inside it), so a click on the value advances to the next option.

Trait Implementations§

Source§

impl Authored for OptionSelect

Source§

const TYPE: &'static str = "OptionSelect"

The registered asset type, as it appears in a world line’s type.
Source§

impl BuildOnlyAsset for OptionSelect

Source§

impl Clone for OptionSelect

Source§

fn clone(&self) -> OptionSelect

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OptionSelect

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OptionSelect

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for OptionSelect

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for OptionSelect

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more