Struct gdnative_core::init::property::hint::RangeHint

pub struct RangeHint<T> {
    pub min: T,
    pub max: T,
    pub step: Option<T>,
    pub or_greater: bool,
    pub or_lesser: bool,
}

Hints that an integer or float property should be within an inclusive range.

Examples

Basic usage:

use gdnative_core::init::property::hint::RangeHint;

let hint: RangeHint<f64> = RangeHint::new(0.0, 20.0).or_greater();

Fields

min: T

Minimal value, inclusive

max: T

Maximal value, inclusive

step: Option<T>

Optional step value for the slider

or_greater: bool

Allow manual input above the max value

or_lesser: bool

Allow manual input below the min value

Methods

impl<T> RangeHint<T> where
    T: Display, 

pub fn new(min: T, max: T) -> Self

Creates a new RangeHint.

pub fn with_step(self, step: T) -> Self

Builder-style method that returns self with the given step.

pub fn or_greater(self) -> Self

Builder-style method that returns self with the or_greater hint.

pub fn or_lesser(self) -> Self

Builder-style method that returns self with the or_lesser hint.

pub fn to_godot_hint_string(&self) -> GodotString

Formats the hint as a Godot hint string.

Trait Implementations

impl<T: Clone> Clone for RangeHint<T>

fn clone(&self) -> RangeHint<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for RangeHint<T>

impl<T: Debug> Debug for RangeHint<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for RangeHint<T>

fn default() -> RangeHint<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for RangeHint<T>

impl<T> From<RangeHint<T>> for IntHint<T> where
    T: Display, 

fn from(hint: RangeHint<T>) -> Self

Performs the conversion.

impl<T> From<RangeHint<T>> for FloatHint<T> where
    T: Display, 

fn from(hint: RangeHint<T>) -> Self

Performs the conversion.

impl<T> From<RangeInclusive<T>> for RangeHint<T> where
    T: Display, 

fn from(range: RangeInclusive<T>) -> Self

Performs the conversion.

impl<T: PartialEq> PartialEq<RangeHint<T>> for RangeHint<T>

fn eq(&self, other: &RangeHint<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RangeHint<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for RangeHint<T>

impl<T> StructuralPartialEq for RangeHint<T>