source_sdk_2013 0.1.0-alpha.7

Higher-level bindings for the Source SDK.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! TF2's playable classes.

use sdk_raw::tf2::class::{
	TF_CLASS_DEMOMAN, TF_CLASS_ENGINEER, TF_CLASS_HEAVYWEAPONS, TF_CLASS_MEDIC, TF_CLASS_PYRO,
	TF_CLASS_SCOUT, TF_CLASS_SNIPER, TF_CLASS_SOLDIER, TF_CLASS_SPY,
};

use std::ffi::c_int;

/// One of TF2's nine playable classes, numbered as the `TF_CLASS_*` constants
/// in `game/shared/tf/tf_shareddefs.h`.
///
/// The Civilian (`TF_CLASS_CIVILIAN`, 10), which players cannot choose and
/// which has no voice lines, is left out.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum PlayerClass {
	/// `TF_CLASS_SCOUT`: 1.
	#[doc(alias("TF_CLASS_SCOUT"))]
	Scout = TF_CLASS_SCOUT as isize,

	/// `TF_CLASS_SNIPER`: 2.
	#[doc(alias("TF_CLASS_SNIPER"))]
	Sniper = TF_CLASS_SNIPER as isize,

	/// `TF_CLASS_SOLDIER`: 3.
	#[doc(alias("TF_CLASS_SOLDIER"))]
	Soldier = TF_CLASS_SOLDIER as isize,

	/// `TF_CLASS_DEMOMAN`: 4.
	#[doc(alias("TF_CLASS_DEMOMAN"))]
	Demoman = TF_CLASS_DEMOMAN as isize,

	/// `TF_CLASS_MEDIC`: 5.
	#[doc(alias("TF_CLASS_MEDIC"))]
	Medic = TF_CLASS_MEDIC as isize,

	/// `TF_CLASS_HEAVYWEAPONS`: 6.
	#[doc(alias("TF_CLASS_HEAVYWEAPONS"))]
	Heavy = TF_CLASS_HEAVYWEAPONS as isize,

	/// `TF_CLASS_PYRO`: 7.
	#[doc(alias("TF_CLASS_PYRO"))]
	Pyro = TF_CLASS_PYRO as isize,

	/// `TF_CLASS_SPY`: 8.
	#[doc(alias("TF_CLASS_SPY"))]
	Spy = TF_CLASS_SPY as isize,

	/// `TF_CLASS_ENGINEER`: 9.
	#[doc(alias("TF_CLASS_ENGINEER"))]
	Engineer = TF_CLASS_ENGINEER as isize,
}

impl PlayerClass {
	/// Every class, in native order.
	pub const ALL: [Self; 9] = [
		Self::Scout,
		Self::Sniper,
		Self::Soldier,
		Self::Demoman,
		Self::Medic,
		Self::Heavy,
		Self::Pyro,
		Self::Spy,
		Self::Engineer,
	];

	/// The class with this `TF_CLASS_*` number, or `None` for any other
	/// number, including `TF_CLASS_UNDEFINED` (0) and the Civilian (10).
	pub const fn from_raw(raw: c_int) -> Option<Self> {
		match raw {
			TF_CLASS_SCOUT => Some(Self::Scout),
			TF_CLASS_SNIPER => Some(Self::Sniper),
			TF_CLASS_SOLDIER => Some(Self::Soldier),
			TF_CLASS_DEMOMAN => Some(Self::Demoman),
			TF_CLASS_MEDIC => Some(Self::Medic),
			TF_CLASS_HEAVYWEAPONS => Some(Self::Heavy),
			TF_CLASS_PYRO => Some(Self::Pyro),
			TF_CLASS_SPY => Some(Self::Spy),
			TF_CLASS_ENGINEER => Some(Self::Engineer),
			_ => None,
		}
	}

	/// The class's directory under `scenes/Player/`, as TF2's response rules
	/// spell it, such as `Heavy`.
	pub const fn scene_directory(self) -> &'static str {
		match self {
			Self::Scout => "Scout",
			Self::Sniper => "Sniper",
			Self::Soldier => "Soldier",
			Self::Demoman => "Demoman",
			Self::Medic => "Medic",
			Self::Heavy => "Heavy",
			Self::Pyro => "Pyro",
			Self::Spy => "Spy",
			Self::Engineer => "Engineer",
		}
	}

	/// The class's `TF_CLASS_*` number.
	pub const fn to_raw(self) -> c_int {
		self as c_int
	}
}