Skip to main content

Class

Struct Class 

Source
pub struct Class { /* private fields */ }
Expand description

Entity class definition.

Represents the type and structure of an entity. Classes define:

  • Class ID: Numeric identifier
  • Class name: Human-readable type name (e.g., “CDOTA_Unit_Hero_Axe”)
  • Serializer: Defines which properties exist and how they’re encoded

§Class Name Patterns

Entity class names follow patterns that help identify their type:

  • CDOTA_Unit_Hero_* - Dota 2 heroes
  • CDOTA_Unit_* - Dota 2 NPCs and units
  • CDOTA_Item_* - Dota 2 item holders
  • CDOTA_* - Other Dota 2 entities
  • CCitadelPlayerPawn - Deadlock players
  • CPlayer_* - CS2 players

§Examples

§Using class information

use source2_demo::prelude::*;

let class = entity.class();
println!("Entity ID: {}", class.id());
println!("Entity name: {}", class.name());

// Check entity type
if class.name().starts_with("CDOTA_Unit_Hero_") {
    println!("This is a hero!");
}

§Finding all entities of a class type

use source2_demo::prelude::*;

// Find all heroes
let heroes: Vec<&Entity> = ctx.entities()
    .iter()
    .filter(|e| e.class().name().starts_with("CDOTA_Unit_Hero_"))
    .collect();

Implementations§

Source§

impl Class

Source

pub fn name(&self) -> &str

Returns the human-readable name of this class.

Examples: “CDOTA_Unit_Hero_Axe”, “CDOTA_PlayerResource”

§Examples
use source2_demo::prelude::*;

match class.name() {
    "CDOTA_PlayerResource" => println!("Found player resource"),
    name if name.starts_with("CDOTA_Unit_Hero_") => println!("Found hero"),
    _ => println!("Other entity type"),
}
Source

pub fn id(&self) -> i32

Returns the numeric ID of this class.

Each class has a unique numeric ID assigned when the replay is parsed. This ID is used internally for efficient entity classification.

§Examples
use source2_demo::prelude::*;

println!("Class ID: {}", class.id());

Trait Implementations§

Source§

impl Clone for Class

Source§

fn clone(&self) -> Class

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Class

Source§

fn default() -> Class

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

Auto Trait Implementations§

§

impl Freeze for Class

§

impl !RefUnwindSafe for Class

§

impl !Send for Class

§

impl !Sync for Class

§

impl Unpin for Class

§

impl UnsafeUnpin for Class

§

impl !UnwindSafe for Class

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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.