v3.0.0-beta

* Add net channel bindings
* Use viable instead of vtables and vtables-derive
* Add much more bindings
* iface! macro now has a third param for type output and can / should be called with just the interface type.
* Update engine example to be more concise with the new iface macro, checking if it is only running on client or menu & using the netchannel bindings.
* Add serverside engine bindings

Author: vurvdev

examples/engine/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "gmod_engine"
 description = "Binary module that accesses engine.dll"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 publish = false
 

examples/engine/src/lib.rs

@@ -1,88 +1,145 @@
-use rglua::interface::{EngineClient};
+use rglua::interface;
 use rglua::prelude::*;
 
-fn get_iface() -> Option<&'static EngineClient> {
-	let iface: *mut EngineClient = iface!("engine", "VEngineClient015")?;
-	unsafe { iface.as_ref() }
+#[lua_function]
+fn concmd(l: LuaState) -> Result<i32, interface::Error> {
+	let engine = iface!(EngineClient)?;
+	engine.ExecuteClientCmd( luaL_checkstring(l, 1) );
+	Ok(0)
 }
 
 #[lua_function]
-fn concmd(l: LuaState) -> i32 {
-	if let Some(iface) = get_iface() {
-		iface.ExecuteClientCmd( luaL_checkstring(l, 1) );
-	}
-	0
+fn get_resolution(l: LuaState) -> Result<i32, interface::Error> {
+	let engine = iface!(EngineClient)?;
+
+	let (w, h) = (&mut 0, &mut 0);
+	engine.GetScreenSize(w, h);
+
+	lua_pushinteger(l, *w as isize);
+	lua_pushinteger(l, *h as isize);
+
+	Ok(2)
 }
 
 #[lua_function]
-fn get_resolution(l: LuaState) -> i32 {
-	if let Some(iface) = get_iface() {
-		let (w, h): (*mut _, *mut _) = (&mut 0, &mut 0);
-		iface.GetScreenSize(w, h);
-		unsafe {
-			lua_pushinteger(l, *w as isize);
-			lua_pushinteger(l, *h as isize);
-		}
-		return 2;
-	}
-	0
+fn get_directory(l: LuaState) -> Result<i32, interface::Error> {
+	let engine = iface!(EngineClient)?;
+
+	let dir = engine.GetGameDirectory();
+	lua_pushstring(l, dir);
+
+	Ok(1)
 }
 
 #[lua_function]
-fn get_directory(l: LuaState) -> i32 {
-	if let Some(iface) = get_iface() {
-		let dir = iface.GetGameDirectory();
-		lua_pushstring(l, dir);
-		return 1;
-	}
-	0
+fn get_level(l: LuaState) -> Result<i32, interface::Error> {
+	let engine = iface!(EngineClient)?;
+
+	let level = engine.GetLevelName();
+	lua_pushstring(l, level);
+
+	Ok(1)
 }
 
 #[lua_function]
-fn get_level(l: LuaState) -> i32 {
-	if let Some(iface) = get_iface() {
-		let level = iface.GetLevelName();
-		lua_pushstring(l, level);
-		return 1;
-	}
-	0
+fn is_recording(l: LuaState) -> Result<i32, interface::Error> {
+	let engine = iface!(EngineClient)?;
+
+	let demo = engine.IsRecordingDemo();
+	lua_pushboolean(l, demo as i32);
+
+	Ok(1)
 }
 
 #[lua_function]
-fn is_recording(l: LuaState) -> i32 {
-	if let Some(iface) = get_iface() {
-		let demo = iface.IsRecordingDemo();
-		lua_pushboolean(l, demo as i32);
-		return 1;
-	}
-	0
+fn is_paused(l: LuaState) -> Result<i32, interface::Error> {
+	let engine = iface!(EngineClient)?;
+
+	let paused = engine.IsPaused();
+	lua_pushboolean(l, paused as i32);
+
+	Ok(1)
 }
 
 #[lua_function]
-fn is_paused(l: LuaState) -> i32 {
-	if let Some(iface) = get_iface() {
-		let paused = iface.IsPaused();
-		lua_pushboolean(l, paused as i32);
-		return 1;
-	}
-	0
+fn is_console_visible(l: LuaState) -> Result<i32, interface::Error> {
+	let engine = iface!(EngineClient)?;
+
+	lua_pushboolean(l, engine.IsConsoleVisible() as i32);
+
+	Ok(1)
+}
+
+#[lua_function]
+fn net_infos(l: LuaState) -> Result<i32, interface::Error> {
+	let flow = luaL_checkinteger(l, 1) as i32;
+
+	let engine = iface!(EngineClient)?;
+
+	let infos = unsafe { engine.GetNetChannelInfo().as_mut() }
+		.ok_or(interface::Error::AsMut)?;
+
+	lua_newtable(l);
+
+	lua_pushstring(l, infos.GetName());
+	lua_setfield(l, -2, cstr!("name"));
+
+	lua_pushstring(l, infos.GetAddress());
+	lua_setfield(l, -2, cstr!("address"));
+
+	lua_pushnumber(l, infos.GetTime() as f64);
+	lua_setfield(l, -2, cstr!("time"));
+
+	lua_pushnumber(l, infos.GetTimeConnected() as f64);
+	lua_setfield(l, -2, cstr!("time_connected"));
+
+	lua_pushnumber(l, infos.GetBufferSize() as f64);
+	lua_setfield(l, -2, cstr!("buffer_size"));
+
+	lua_pushnumber(l, infos.GetDataRate() as f64);
+	lua_setfield(l, -2, cstr!("data_rate"));
+
+	lua_pushnumber(l, infos.GetAvgLoss(flow) as f64);
+	lua_setfield(l, -2, cstr!("avg_loss"));
+
+	lua_pushnumber(l, infos.GetAvgChoke(flow) as f64);
+	lua_setfield(l, -2, cstr!("avg_choke"));
+
+	lua_pushnumber(l, infos.GetAvgData(flow) as f64);
+	lua_setfield(l, -2, cstr!("avg_data"));
+
+	lua_pushnumber(l, infos.GetAvgLatency(flow) as f64);
+	lua_setfield(l, -2, cstr!("avg_latency"));
+
+	Ok(1)
 }
 
 #[gmod_open]
-fn open(l: LuaState) -> i32 {
+fn open(l: LuaState) -> Result<i32, interface::Error> {
 	printgm!(l, "Loaded engine module!");
 
+	let lua = iface!(LuaShared)?;
+
+	let client = lua.GetLuaInterface(0);
+	let menu = lua.GetLuaInterface(2);
+	if client.is_null() && menu.is_null() {
+		// TODO: Serverside support & Clientside in one module :)
+		luaL_error(l, cstr!("This module is only compatible with the CLIENT or MENU states!"));
+	}
+
 	let lib = reg! [
 		"concmd" => concmd,
 		"getResolution" => get_resolution,
 		"getGameDirectory" => get_directory,
 		"getLevel" => get_level,
 		"isRecording" => is_recording,
-		"isPaused" => is_paused
+		"isPaused" => is_paused,
+		"isConsoleVisible" => is_console_visible,
+		"getNetInfo" => net_infos
 	];
 
 	luaL_register(l, cstr!("iengine"), lib.as_ptr());
-	0
+	Ok(0)
 }
 
 #[gmod_close]

examples/interfaces/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "gmod_interfaces"
+description = "Binary module displaying basic functionality from source interfaces"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+rglua = { path = "../../rglua" }
+thiserror = "1.0.30"

examples/interfaces/src/lib.rs

@@ -0,0 +1,27 @@
+use rglua::prelude::*;
+use rglua::interface::{self, LuaShared};
+
+#[derive(Debug, thiserror::Error)]
+enum GenericError {
+	#[error("Couldn't get interface {0}")]
+	NoInterface(String),
+
+	#[error("Couldn't get interface as reference {0}")]
+	AsMut(String)
+}
+
+#[gmod_open]
+fn open(l: LuaState) -> Result<i32, GenericError> {
+	// Access the lua state when you aren't directly given it.
+	let lua_shared = iface!(LuaShared)?;
+	let menu = unsafe { lua_shared.GetLuaInterface(2).as_mut() }
+		.ok_or(interface::Error::AsMut)?;
+
+	printgm!(menu.base as _, "Hello from ILuaShared!");
+	Ok(0)
+}
+
+#[gmod_close]
+fn close(_l: LuaState) -> i32 {
+	0
+}

rglua/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "rglua"
 description = "Toolkit for garrysmod development with the source sdk and luajit api"
-version = "2.1.0"
+version = "3.0.0-beta"
 authors = ["Vurv <vurvdevelops@gmail.com>"]
 keywords = ["glua", "garrysmod", "lua", "gmod"]
 categories = ["api-bindings", "external-ffi-bindings", "development-tools::ffi", "game-development", "accessibility"]
@@ -20,12 +20,10 @@ thiserror = "1.0.30"
 rglua-macros = { version = "0.2.0", path = "../rglua-macros" }
 derive_more = { version = "0.99.17", optional = true }
 
-vtables = { version = "0.1.0", optional = true }
-vtables_derive = { version = "0.1.0", optional = true }
+viable = { version = "0.1", optional = true }
 
 [features]
 default = ["interfaces", "userdata"]
 
-interfaces = ["vtables", "vtables_derive"]
-
+interfaces = ["viable"]
 userdata = ["derive_more"]