Struct game_library::CameraScaleLevel

pub struct CameraScaleLevel { /* private fields */ }

Component that stores the current camera scale level.

This is used to zoom the camera in and out.

Default Value

The default value is 0.3.

Possible Values

The possible values are 0.1, 0.25, 0.3, 0.5, and 1.0.

These are available as constants on the struct:

• CameraScaleLevel::LEVELS

Implementations

impl CameraScaleLevel

pub const LEVELS: [f32; 5] = _

The possible values for the camera scale level.

pub const fn value(&self) -> f32

Returns the current camera scale level.

Example

use game_library::CameraScaleLevel;

let level = CameraScaleLevel::default();

assert_eq!(level.value(), 0.3);

pub fn zoom_out(&mut self)

Increases the camera scale level. If the level is already at the maximum, it will not increase. Note that increasing the level (zooming in) means the scale value will be smaller.

Example

use game_library::CameraScaleLevel;

let mut level = CameraScaleLevel::default();

assert_eq!(level.value(), 0.3);

level.zoom_out();

assert_eq!(level.value(), 0.5);

pub fn zoom_in(&mut self)

Decreases the camera scale level. If the level is already at the minimum, it will not decrease. Note that decreasing the level (zooming out) means the scale value will be larger.

Example

use game_library::CameraScaleLevel;

let mut level = CameraScaleLevel::default();

assert_eq!(level.value(), 0.3);

level.zoom_in();

assert_eq!(level.value(), 0.25);

Trait Implementations

impl Clone for CameraScaleLevel

fn clone(&self) -> CameraScaleLevel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for CameraScaleLevel

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for CameraScaleLevel

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

Formats the value using the given formatter.

impl Default for CameraScaleLevel

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CameraScaleLevel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CameraScaleLevel

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

Formats the value using the given formatter.

impl From<CameraScaleLevel> for f32

fn from(level: CameraScaleLevel) -> Self

Converts to this type from the input type.

impl From<f32> for CameraScaleLevel

fn from(value: f32) -> Self

Converts to this type from the input type.

impl FromReflect for CameraScaleLevel

where f32: FromReflect + TypePath, usize: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl FromType<CameraScaleLevel> for InspectorOptions

fn from_type() -> Self

impl GetTypeRegistration for CameraScaleLevel

where f32: FromReflect + TypePath, usize: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for CameraScaleLevel

where f32: FromReflect + TypePath, usize: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the [TypeInfo] of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn type_name(&self) -> &str

👎Deprecated since 0.12.0: view the method documentation to find alternatives to this method.

Returns the type path of the underlying type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for CameraScaleLevel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for CameraScaleLevel

where f32: FromReflect + TypePath, usize: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl TypePath for CameraScaleLevel

where f32: FromReflect + TypePath, usize: FromReflect + TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for CameraScaleLevel

where f32: FromReflect + TypePath, usize: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for CameraScaleLevel