Struct game_library::Xp

pub struct Xp {
    pub value: u32,
    pub total_xp: u32,
    pub current_level: u32,
    pub factor_a: u32,
    pub factor_b: u32,
    pub factor_c: u32,
    pub base_xp: u32,
}

Experience component

Tracks the amount of xp accumulated by an entity. The xp curve is defined by the following formula:

(level - 1) ^ (factor_a / factor_b) / factor_c + base_xp

The result is rounded down to the nearest integer.

Expected Usage

The idea is on an entity to track xp you will add the Xp component. This component will track the amount of xp accumulated. When you perform a level up action, you should call level_up on the component. This will increase the level and reset the xp (for this level) to 0. Total xp will continue to accumulate, and if there was extra xp accumulated, it will be rolled over to the next level.

Example

use bevy::prelude::*;
use game_library::Xp;

#[derive(Component)]
struct Player;

/// A system to run on [KeyboardInput] which adds xp to the player
pub fn add_xp_system(
   mut query: Query<&mut Xp, With<Player>>,
  keyboard_input: Res<Input<KeyCode>>,
) {
  for mut xp in &mut query {
     if keyboard_input.just_pressed(KeyCode::Equals) {
       xp.add(10);
      // Or you can use the += operator: xp += 10;
    }
 }
}

/// A system to run on [Update] which checks if the player can level up
pub fn level_up_system(mut query: Query<&mut Xp, With<Player>>) {
 for mut xp in &mut query {
   if xp.can_level_up() {
    xp.level_up();
    println!("Player leveled up to level {}", xp.current_level);
   }
 }
}

Fields

value: u32

Amount of xp accumulated for this level

total_xp: u32

Total amount of xp accumulated

current_level: u32

Current level of the entity

factor_a: u32

Scaling factor A for the xp curve

factor_b: u32

Scaling factor B for the xp curve

factor_c: u32

Scaling factor C for the xp curve

base_xp: u32

Base xp (i.e. xp required to reach level 2)

Implementations

impl Xp

pub fn xp_required(&self, level: u32) -> u32

Formula for calculating the xp required to reach a given level

(level - 1) ^ (factor_a / factor_b) / factor_c + base_xp

The result is rounded down to the nearest integer.

Examples

use game_library::Xp;

let xp = Xp {
  value: 0,
  total_xp: 0,
  current_level: 1,
  factor_a: 10,
  factor_b: 5,
  factor_c: 5,
  base_xp: 10,
};

assert_eq!(xp.xp_required(1), 10); // 11 xp to level 2
assert_eq!(xp.xp_required(2), 10);
assert_eq!(xp.xp_required(3), 10);
assert_eq!(xp.xp_required(4), 11);
assert_eq!(xp.xp_required(5), 13);
assert_eq!(xp.xp_required(6), 15);

pub fn total_xp_to_next_level(&self) -> u32

Total amount of xp required to reach the next level.

pub fn remaining_xp_to_next_level(&self) -> u32

Remaining amount of xp required to reach the next level.

pub fn next_level_progress(&self) -> f32

Progress towards the next level as a percentage.

pub fn can_level_up(&self) -> bool

Can the entity level up?

pub fn level_up(&mut self)

Level up the entity

pub fn add(&mut self, amount: u32)

Add some amount to the xp value

Trait Implementations

impl AddAssign<i32> for Xp

fn add_assign(&mut self, rhs: i32)

Add some amount to the xp value. (Subtracting can only subtract xp from the current level’s total, not from the overall total xp)

impl AddAssign<u32> for Xp

fn add_assign(&mut self, rhs: u32)

Add some amount to the xp value

impl Clone for Xp

fn clone(&self) -> Xp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Xp

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 Xp

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

Formats the value using the given formatter.

impl Default for Xp

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Xp

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Xp

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

Formats the value using the given formatter.

impl FromReflect for Xp

where u32: 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<Xp> for InspectorOptions

fn from_type() -> Self

impl GetTypeRegistration for Xp

where u32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Hash for Xp

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Xp

fn eq(&self, other: &Xp) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Percentage for Xp

fn percentage(&self) -> f32

Returns the percentage of the value to draw.

impl Reflect for Xp

where u32: 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 Xp

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 Xp

where u32: 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 SubAssign<i32> for Xp

fn sub_assign(&mut self, rhs: i32)

Subtract some amount from the xp value. (Subtracting can only subtract xp from the current level’s total, not from the overall total xp)

impl SubAssign<u32> for Xp

fn sub_assign(&mut self, rhs: u32)

Subtract some amount from the xp value. (Subtracting can only subtract xp from the current level’s total, not from the overall total xp)

impl TypePath for Xp

where u32: 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 Xp

where u32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Xp

impl Eq for Xp

impl Resource for Xp

where Self: Send + Sync + 'static,

impl StructuralEq for Xp

impl StructuralPartialEq for Xp