source_sdk_2013 0.1.0-alpha.8

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

//! Handles to the interfaces a server plugin can request from the engine and
//! game server, each obtained from a [`Server`](crate::Server).
//!
//! A handle is a copyable, non-owning pointer to a process-wide singleton,
//! bound to the scope of the `Server` that produced it. Methods take `self`
//! and never create Rust references into the object, since the engine mutates
//! it through its own pointers at any time.

/// Declares the handle type of an interface that needs no state beyond its
/// pointer.
macro_rules! interface {
	(
		$(#[$meta:meta])*
		$vis:vis struct $Name:ident($Raw:ty) = $Module:ident $version:expr;
	) => {
		$(#[$meta])*
		#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
		$vis struct $Name<'s> {
			raw: ::core::ptr::NonNull<$Raw>,
			_scope: ::core::marker::PhantomData<&'s ()>,
			_not_thread_safe: $crate::NotThreadSafe,
		}

		impl<'s> $Name<'s> {
			/// The version string this interface is requested by.
			pub const VERSION: &'static ::core::ffi::CStr = $version;

			/// Wraps the interface pointer an interface factory returned.
			///
			/// # Safety
			///
			/// `raw` must be the live object exported under
			/// [`Self::VERSION`], alive for `'s`, and every call must happen
			/// on the server's main thread.
			pub(crate) const unsafe fn from_raw(raw: ::core::ptr::NonNull<$Raw>) -> Self {
				Self {
					raw,
					_scope: ::core::marker::PhantomData,
					_not_thread_safe: ::core::marker::PhantomData,
				}
			}

			/// Returns the interface pointer, for calls this crate does not wrap.
			pub const fn as_ptr(self) -> *mut $Raw {
				self.raw.as_ptr()
			}
		}

		// SAFETY: `$Raw` is the class exported under `$version`, and `bind`
		// only wraps the pointer.
		unsafe impl<'s> $crate::server::Interface<'s> for $Name<'s> {
			type Raw = $Raw;

			const MODULE: $crate::server::Module = $crate::server::Module::$Module;
			const VERSION: &'static ::core::ffi::CStr = $version;

			unsafe fn bind(raw: ::core::ptr::NonNull<$Raw>, _server: &$crate::server::Server<'s>) -> Self {
				// SAFETY: The caller upholds the same contract.
				unsafe { Self::from_raw(raw) }
			}
		}
	};
}

pub mod bot_manager;
pub mod cvar;
pub mod engine_replay;
pub mod engine_sound;
pub mod engine_trace;
pub mod game_event;
pub mod game_server;
pub mod model_info;
pub mod network_string_tables;
pub mod player_info_manager;
pub mod plugin_helpers;
pub mod server_game_clients;
pub mod server_game_dll;
pub mod server_game_ents;
pub mod server_game_tags;
pub mod server_tools;
pub mod temp_entities;
pub mod valve_engine;
pub mod voice_server;

pub use bot_manager::BotManager;
pub use cvar::Cvar;
pub use engine_replay::EngineReplay;
pub use engine_sound::EngineSound;
pub use engine_trace::EngineTrace;
pub use game_event::GameEventManager;
pub use game_server::{GameClient, GameServer};
pub use model_info::ModelInfo;
pub use network_string_tables::NetworkStringTables;
pub use player_info_manager::PlayerInfoManager;
pub use plugin_helpers::PluginHelpers;
pub use server_game_clients::ServerGameClients;
pub use server_game_dll::ServerGameDll;
pub use server_game_ents::ServerGameEnts;
pub use server_game_tags::ServerGameTags;
pub use server_tools::ServerTools;
pub use temp_entities::TempEntities;
pub use valve_engine::ValveEngine;
pub use voice_server::VoiceServer;