Struct game_library::SpellData

pub struct SpellData {

    pub internal_id: Option<String>,
    pub name: String,
    pub description: String,
    pub long_description: String,
    pub spell_tier: usize,
    pub magic: MagicType,
    pub cast_slot: CastSlot,
    pub collision: SpellCollision,
    pub cast_type: CastType,
    pub cast_category: CastCategory,
    pub icon_tileset: String,
    pub icon_index: usize,
    pub sprite_tileset: String,
    pub sprite_index: usize,
    pub cooldown: f32,
    pub cast_time: f32,
    pub mana_cost: usize,
    pub range: f32,
    pub speed: f32,
    pub duration: f32,
    pub damage: i32,
    pub healing: i32,
    pub radius: i32,
    pub angle: i32,
    pub buffs: Vec<StatEffect>,
    pub debuffs: Vec<StatEffect>,
    pub particles: Vec<SpellParticles>,
}

Details about a spell.

Describes in detail how a spell works and how it should be displayed.

Fields

internal_id: Option<String>

The internal ID of the spell.

name: String

The name of the spell.

description: String

A short description of the spell.

long_description: String

A longer description of the spell.

spell_tier: usize

The tier of the spell (0-9 officially).

magic: MagicType

The type of magic the spell uses.

cast_slot: CastSlot

The slot the spell can be cast from.

collision: SpellCollision

The type of collision the spell has.

cast_type: CastType

The type of cast the spell has.

cast_category: CastCategory

How the spell is targeted

icon_tileset: String

The path to the icon for the spell (relative to the game’s asset directory).

icon_index: usize

The index of the spell’s icon in the tileset.

sprite_tileset: String

The path to the sprite tileset for the spell (relative to the game’s asset directory).

sprite_index: usize

The index of the spell’s sprite in the tileset.

cooldown: f32

The cooldown of the spell in seconds

cast_time: f32

The cast time of the spell in seconds

mana_cost: usize

The mana cost of the spell (mana is an integer value)

range: f32

The range of the spell in centimeters.

speed: f32

The speed of the spell in meters per second.

duration: f32

The duration of the spell in seconds.

damage: i32

The base damage of the spell, 0 if the spell does not deal damage.

healing: i32

The base healing of the spell, 0 if the spell does not heal.

radius: i32

Radius of the spell “detonation” in centimeters.

Spells which target the ground use this value to determine the radius of the area of effect.

Spells which are cone or line shaped use this value to determine the width of the cone or line.

angle: i32

The angle of the spell in degrees.

Spells which are cone shaped use this value to determine the angle of the cone.

buffs: Vec<StatEffect>

Buffs that the spell can apply to the caster or to the target.

debuffs: Vec<StatEffect>

Debuffs that the spell can apply to the caster or to the target.

particles: Vec<SpellParticles>

Particles that the spell can create.

Implementations

impl SpellData

pub fn skill(&self) -> Skill

Returns the skill that the spell uses.

pub fn texture_atlas_index(&self) -> TextureAtlasSprite

Get the spell’s sprite as a texture atlas sprite.

Trait Implementations

impl Clone for SpellData

fn clone(&self) -> SpellData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpellData

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

Formats the value using the given formatter.

impl Default for SpellData

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpellData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for SpellData

where Option<String>: FromReflect + TypePath, String: FromReflect + TypePath, usize: FromReflect + TypePath, MagicType: FromReflect + TypePath, CastSlot: FromReflect + TypePath, SpellCollision: FromReflect + TypePath, CastType: FromReflect + TypePath, CastCategory: FromReflect + TypePath, f32: FromReflect + TypePath, i32: FromReflect + TypePath, Vec<StatEffect>: FromReflect + TypePath, Vec<SpellParticles>: 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 GetTypeRegistration for SpellData

where Option<String>: FromReflect + TypePath, String: FromReflect + TypePath, usize: FromReflect + TypePath, MagicType: FromReflect + TypePath, CastSlot: FromReflect + TypePath, SpellCollision: FromReflect + TypePath, CastType: FromReflect + TypePath, CastCategory: FromReflect + TypePath, f32: FromReflect + TypePath, i32: FromReflect + TypePath, Vec<StatEffect>: FromReflect + TypePath, Vec<SpellParticles>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Hash for SpellData

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 InternalId for SpellData

fn update_internal_id(&mut self)

Update the spell’s internal ID.

fn get_internal_id(&self) -> String

Get the spell’s internal ID.

impl Reflect for SpellData

where Option<String>: FromReflect + TypePath, String: FromReflect + TypePath, usize: FromReflect + TypePath, MagicType: FromReflect + TypePath, CastSlot: FromReflect + TypePath, SpellCollision: FromReflect + TypePath, CastType: FromReflect + TypePath, CastCategory: FromReflect + TypePath, f32: FromReflect + TypePath, i32: FromReflect + TypePath, Vec<StatEffect>: FromReflect + TypePath, Vec<SpellParticles>: 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 SpellData

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 SpellData

where Option<String>: FromReflect + TypePath, String: FromReflect + TypePath, usize: FromReflect + TypePath, MagicType: FromReflect + TypePath, CastSlot: FromReflect + TypePath, SpellCollision: FromReflect + TypePath, CastType: FromReflect + TypePath, CastCategory: FromReflect + TypePath, f32: FromReflect + TypePath, i32: FromReflect + TypePath, Vec<StatEffect>: FromReflect + TypePath, Vec<SpellParticles>: 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<D: Hash + InternalId + 'static> TryFrom<&DataFile<D>> for SpellData

type Error = ()

The type returned in the event of a conversion error.

fn try_from(data_file: &DataFile<D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Hash + InternalId + 'static> TryInto<SpellData> for DataFile<D>

type Error = ()

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SpellData, Self::Error>

Performs the conversion.

impl TypePath for SpellData

where Option<String>: FromReflect + TypePath, String: FromReflect + TypePath, usize: FromReflect + TypePath, MagicType: FromReflect + TypePath, CastSlot: FromReflect + TypePath, SpellCollision: FromReflect + TypePath, CastType: FromReflect + TypePath, CastCategory: FromReflect + TypePath, f32: FromReflect + TypePath, i32: FromReflect + TypePath, Vec<StatEffect>: FromReflect + TypePath, Vec<SpellParticles>: 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 SpellData

where Option<String>: FromReflect + TypePath, String: FromReflect + TypePath, usize: FromReflect + TypePath, MagicType: FromReflect + TypePath, CastSlot: FromReflect + TypePath, SpellCollision: FromReflect + TypePath, CastType: FromReflect + TypePath, CastCategory: FromReflect + TypePath, f32: FromReflect + TypePath, i32: FromReflect + TypePath, Vec<StatEffect>: FromReflect + TypePath, Vec<SpellParticles>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.