v0.4.7 RBXScriptSignal + RunService

.cargo/config.toml

@@ -0,0 +1,2 @@
+[registries.strafesnet]
+index = "sparse+https://git.itzana.me/api/packages/strafesnet/cargo/"

Cargo.lock

@@ -402,7 +402,7 @@ dependencies = [
 
 [[package]]
 name = "roblox_emulator"
-version = "0.4.5"
+version = "0.4.7"
 dependencies = [
  "glam",
  "mlua",

Cargo.toml

@@ -1,12 +1,16 @@
 [package]
 name = "roblox_emulator"
-version = "0.4.5"
+version = "0.4.7"
 edition = "2021"
 repository = "https://git.itzana.me/StrafesNET/roblox_emulator"
 license = "MIT OR Apache-2.0"
 description = "Run embedded Luau scripts which manipulate the DOM."
 authors = ["Rhys Lloyd <krakow20@gmail.com>"]
 
+[features]
+default=["run-service"]
+run-service=[]
+
 [dependencies]
 glam = "0.29.0"
 mlua = { version = "0.10.0-beta", features = ["luau"] }

src/context.rs

@@ -46,21 +46,11 @@ impl Context{
 		self.superclass_iter("LuaSourceContainer").map(crate::runner::instance::Instance::new).collect()
 	}
 
-	fn get_service(&self,service:&str)->Option<Ref>{
-		self.dom.root().children().iter().find(|&&r|
-			self.dom.get_by_ref(r).is_some_and(|instance|instance.class==service)
-		).copied()
-	}
-	fn get_or_create_service(&mut self,service:&str,mut create:impl FnMut(&mut Context)->Ref)->Ref{
-		match self.get_service(service){
-			Some(referent)=>referent,
-			None=>create(self),
-		}
-	}
 	pub fn find_services(&self)->Option<Services>{
 		Some(Services{
-			workspace:self.get_service("Workspace")?,
+			workspace:*self.dom.root().children().iter().find(|&&r|
-			nil:self.get_service("Nil")?,
+				self.dom.get_by_ref(r).is_some_and(|instance|instance.class=="Workspace")
+			)?,
 			game:self.dom.root_ref(),
 		})
 	}
@@ -70,15 +60,13 @@ impl Context{
 
 		//insert services
 		let game=self.dom.root_ref();
-		let workspace=self.get_or_create_service("Workspace",|context|{
 		let terrain_bldr=InstanceBuilder::new("Terrain");
-			context.dom.insert(game,
+		let workspace=self.dom.insert(game,
 			InstanceBuilder::new("Workspace")
 				//Set Workspace.Terrain property equal to Terrain
 				.with_property("Terrain",terrain_bldr.referent())
 				.with_child(terrain_bldr)
-			)
+		);
-		});
 		{
 			//Lowercase and upper case workspace property!
 			let game=self.dom.root_mut();
@@ -86,17 +74,6 @@ impl Context{
 			game.properties.insert("Workspace".to_owned(),rbx_types::Variant::Ref(workspace));
 		}
 		self.dom.insert(game,InstanceBuilder::new("Lighting"));
-		// Special nonexistent class that holds instances parented to nil,
-		// which can still be referenced by scripts.
-		// Using a sentinel value as a ref because global variables are hard.
-		let nil=self.get_or_create_service("Nil",|context|
-			context.dom.insert(
-				game,InstanceBuilder::new("Nil")
-				.with_referent(
-					<Ref as std::str::FromStr>::from_str("ffffffffffffffffffffffffffffffff").unwrap()
-				)
-			)
-		);
 
 		//transfer original root instances into workspace
 		for instance in children{
@@ -106,7 +83,6 @@ impl Context{
 		Services{
 			game,
 			workspace,
-			nil,
 		}
 	}
 }
@@ -114,5 +90,4 @@ impl Context{
 pub struct Services{
 	pub game:Ref,
 	pub workspace:Ref,
-	pub nil:Ref,
 }

src/lib.rs

@@ -1,5 +1,7 @@
 pub mod runner;
 pub mod context;
+#[cfg(feature="run-service")]
+pub(crate) mod scheduler;
 
 #[cfg(test)]
 mod tests;

src/runner/instance/instance.rs

@@ -4,11 +4,12 @@ use mlua::{FromLua,FromLuaMulti,IntoLua,IntoLuaMulti};
 use rbx_types::Ref;
 use rbx_dom_weak::{InstanceBuilder,WeakDom};
 
-use super::vector3::Vector3;
+use crate::runner::vector3::Vector3;
 
 pub fn set_globals(lua:&mlua::Lua,globals:&mlua::Table)->Result<(),mlua::Error>{
 	//class functions store
-	lua.set_app_data(ClassFunctions::default());
+	lua.set_app_data(ClassMethodsStore::default());
+	lua.set_app_data(InstanceValueStore::default());
 
 	let instance_table=lua.create_table()?;
 
@@ -16,8 +17,9 @@ pub fn set_globals(lua:&mlua::Lua,globals:&mlua::Table)->Result<(),mlua::Error>{
 	instance_table.raw_set("new",
 		lua.create_function(|lua,(class_name,parent):(mlua::String,Option<Instance>)|{
 			let class_name_str=&*class_name.to_str()?;
-			let parent=parent.unwrap_or(Instance::nil());
+			let parent=parent.ok_or_else(||mlua::Error::runtime("Nil Parent not yet supported"))?;
 			dom_mut(lua,|dom|{
+				//TODO: Nil instances
 				Ok(Instance::new(dom.insert(parent.referent,InstanceBuilder::new(class_name_str))))
 			})
 		})?
@@ -29,14 +31,10 @@ pub fn set_globals(lua:&mlua::Lua,globals:&mlua::Table)->Result<(),mlua::Error>{
 }
 
 // LMAO look at this function!
-fn dom_mut<T>(lua:&mlua::Lua,mut f:impl FnMut(&mut WeakDom)->mlua::Result<T>)->mlua::Result<T>{
+pub fn dom_mut<T>(lua:&mlua::Lua,mut f:impl FnMut(&mut WeakDom)->mlua::Result<T>)->mlua::Result<T>{
-	let mut dom=lua.app_data_mut::<&'static mut WeakDom>().ok_or(mlua::Error::runtime("DataModel missing"))?;
+	let mut dom=lua.app_data_mut::<&'static mut WeakDom>().ok_or_else(||mlua::Error::runtime("DataModel missing"))?;
 	f(&mut *dom)
 }
-fn class_functions_mut<T>(lua:&mlua::Lua,mut f:impl FnMut(&mut ClassFunctions)->mlua::Result<T>)->mlua::Result<T>{
-	let mut cf=lua.app_data_mut::<ClassFunctions>().ok_or(mlua::Error::runtime("ClassFunctions missing"))?;
-	f(&mut *cf)
-}
 
 fn coerce_float32(value:&mlua::Value)->Option<f32>{
 	match value{
@@ -90,17 +88,11 @@ impl Instance{
 	pub const fn new(referent:Ref)->Self{
 		Self{referent}
 	}
-	// Using a sentinel value as a ref for nil instances because global variables are hard.
-	pub fn nil()->Self{
-		Self{
-			referent:<Ref as std::str::FromStr>::from_str("ffffffffffffffffffffffffffffffff").unwrap()
-		}
-	}
 	pub fn get<'a>(&self,dom:&'a WeakDom)->mlua::Result<&'a rbx_dom_weak::Instance>{
-		dom.get_by_ref(self.referent).ok_or(mlua::Error::runtime("Instance missing"))
+		dom.get_by_ref(self.referent).ok_or_else(||mlua::Error::runtime("Instance missing"))
 	}
 	pub fn get_mut<'a>(&self,dom:&'a mut WeakDom)->mlua::Result<&'a mut rbx_dom_weak::Instance>{
-		dom.get_by_ref_mut(self.referent).ok_or(mlua::Error::runtime("Instance missing"))
+		dom.get_by_ref_mut(self.referent).ok_or_else(||mlua::Error::runtime("Instance missing"))
 	}
 }
 type_from_lua_userdata!(Instance);
@@ -129,12 +121,11 @@ impl mlua::UserData for Instance{
 		fields.add_field_method_get("Parent",|lua,this|{
 			dom_mut(lua,|dom|{
 				let instance=this.get(dom)?;
-				//TODO: return nil when parent is Nil instances
 				Ok(Instance::new(instance.parent()))
 			})
 		});
 		fields.add_field_method_set("Parent",|lua,this,val:Option<Instance>|{
-			let parent=val.unwrap_or(Instance::nil());
+			let parent=val.ok_or_else(||mlua::Error::runtime("Nil Parent not yet supported"))?;
 			dom_mut(lua,|dom|{
 				dom.transfer_within(this.referent,parent.referent);
 				Ok(())
@@ -224,7 +215,7 @@ impl mlua::UserData for Instance{
 		);
 		methods.add_method("Destroy",|lua,this,()|
 			dom_mut(lua,|dom|{
-				dom.transfer_within(this.referent,Instance::nil().referent);
+				dom.destroy(this.referent);
 				Ok(())
 			})
 		);
@@ -240,7 +231,7 @@ impl mlua::UserData for Instance{
 				let instance=this.get(dom)?;
 				//println!("__index t={} i={index:?}",instance.name);
 				let db=rbx_reflection_database::get();
-				let class=db.classes.get(instance.class.as_str()).ok_or(mlua::Error::runtime("Class missing"))?;
+				let class=db.classes.get(instance.class.as_str()).ok_or_else(||mlua::Error::runtime("Class missing"))?;
 				//Find existing property
 				match instance.properties.get(index_str)
 					.cloned()
@@ -262,13 +253,13 @@ impl mlua::UserData for Instance{
 					Some(rbx_types::Variant::Float32(val))=>return val.into_lua(lua),
 					Some(rbx_types::Variant::Float64(val))=>return val.into_lua(lua),
 					Some(rbx_types::Variant::Ref(val))=>return Instance::new(val).into_lua(lua),
-					Some(rbx_types::Variant::CFrame(cf))=>return Into::<super::cframe::CFrame>::into(cf).into_lua(lua),
+					Some(rbx_types::Variant::CFrame(cf))=>return Into::<crate::runner::cframe::CFrame>::into(cf).into_lua(lua),
-					Some(rbx_types::Variant::Vector3(v))=>return Into::<super::vector3::Vector3>::into(v).into_lua(lua),
+					Some(rbx_types::Variant::Vector3(v))=>return Into::<crate::runner::vector3::Vector3>::into(v).into_lua(lua),
 					None=>(),
 					other=>return Err(mlua::Error::runtime(format!("Instance.__index Unsupported property type instance={} index={index_str} value={other:?}",instance.name))),
 				}
 				//find a function with a matching name
-				if let Some(function)=class_functions_mut(lua,|cf|{
+				if let Some(function)=class_methods_store_mut(lua,|cf|{
 					let mut iter=SuperClassIter{
 						database:db,
 						descriptor:Some(class),
@@ -281,6 +272,17 @@ impl mlua::UserData for Instance{
 				})?{
 					return function.into_lua(lua);
 				}
+
+				//find or create an associated userdata object
+				if let Some(value)=instance_value_store_mut(lua,|ivs|{
+					//TODO: walk class tree somehow
+					match ivs.get_or_create_instance_values(&instance){
+						Some(mut instance_values)=>instance_values.get_or_create_value(lua,index_str),
+						None=>Ok(None)
+					}
+				})?{
+					return value.into_lua(lua);
+				}
 				//find a child with a matching name
 				find_first_child(dom,instance,index_str)
 				.map(|instance|Instance::new(instance.referent()))
@@ -293,19 +295,19 @@ impl mlua::UserData for Instance{
 				//println!("__newindex t={} i={index:?} v={value:?}",instance.name);
 				let index_str=&*index.to_str()?;
 				let db=rbx_reflection_database::get();
-				let class=db.classes.get(instance.class.as_str()).ok_or(mlua::Error::runtime("Class missing"))?;
+				let class=db.classes.get(instance.class.as_str()).ok_or_else(||mlua::Error::runtime("Class missing"))?;
 				let mut iter=SuperClassIter{
 					database:db,
 					descriptor:Some(class),
 				};
-				let property=iter.find_map(|cls|cls.properties.get(index_str)).ok_or(mlua::Error::runtime(format!("Property '{index_str}' missing on class '{}'",class.name)))?;
+				let property=iter.find_map(|cls|cls.properties.get(index_str)).ok_or_else(||mlua::Error::runtime(format!("Property '{index_str}' missing on class '{}'",class.name)))?;
 				match &property.data_type{
 					rbx_reflection::DataType::Value(rbx_types::VariantType::Vector3)=>{
-						let typed_value:Vector3=*value.as_userdata().ok_or(mlua::Error::runtime("Expected Userdata"))?.borrow()?;
+						let typed_value:Vector3=*value.as_userdata().ok_or_else(||mlua::Error::runtime("Expected Userdata"))?.borrow()?;
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::Vector3(typed_value.into()));
 					},
 					rbx_reflection::DataType::Value(rbx_types::VariantType::Float32)=>{
-						let typed_value:f32=coerce_float32(&value).ok_or(mlua::Error::runtime("Expected f32"))?;
+						let typed_value:f32=coerce_float32(&value).ok_or_else(||mlua::Error::runtime("Expected f32"))?;
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::Float32(typed_value));
 					},
 					rbx_reflection::DataType::Enum(enum_name)=>{
@@ -313,11 +315,11 @@ impl mlua::UserData for Instance{
 							&mlua::Value::Integer(int)=>Ok(rbx_types::Enum::from_u32(int as u32)),
 							&mlua::Value::Number(num)=>Ok(rbx_types::Enum::from_u32(num as u32)),
 							mlua::Value::String(s)=>{
-								let e=db.enums.get(enum_name).ok_or(mlua::Error::runtime("Database DataType Enum name  does not exist"))?;
+								let e=db.enums.get(enum_name).ok_or_else(||mlua::Error::runtime("Database DataType Enum name  does not exist"))?;
-								Ok(rbx_types::Enum::from_u32(*e.items.get(&*s.to_str()?).ok_or(mlua::Error::runtime("Invalid enum item"))?))
+								Ok(rbx_types::Enum::from_u32(*e.items.get(&*s.to_str()?).ok_or_else(||mlua::Error::runtime("Invalid enum item"))?))
 							},
 							mlua::Value::UserData(any_user_data)=>{
-								let e:super::r#enum::Enum=*any_user_data.borrow()?;
+								let e:crate::runner::r#enum::Enum=*any_user_data.borrow()?;
 								Ok(e.into())
 							},
 							_=>Err(mlua::Error::runtime("Expected Enum")),
@@ -325,23 +327,23 @@ impl mlua::UserData for Instance{
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::Enum(typed_value));
 					},
 					rbx_reflection::DataType::Value(rbx_types::VariantType::Color3)=>{
-						let typed_value:super::color3::Color3=*value.as_userdata().ok_or(mlua::Error::runtime("Expected Color3"))?.borrow()?;
+						let typed_value:crate::runner::color3::Color3=*value.as_userdata().ok_or_else(||mlua::Error::runtime("Expected Color3"))?.borrow()?;
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::Color3(typed_value.into()));
 					},
 					rbx_reflection::DataType::Value(rbx_types::VariantType::Bool)=>{
-						let typed_value=value.as_boolean().ok_or(mlua::Error::runtime("Expected boolean"))?;
+						let typed_value=value.as_boolean().ok_or_else(||mlua::Error::runtime("Expected boolean"))?;
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::Bool(typed_value));
 					},
 					rbx_reflection::DataType::Value(rbx_types::VariantType::String)=>{
-						let typed_value=value.as_str().ok_or(mlua::Error::runtime("Expected boolean"))?;
+						let typed_value=value.as_str().ok_or_else(||mlua::Error::runtime("Expected boolean"))?;
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::String(typed_value.to_owned()));
 					},
 					rbx_reflection::DataType::Value(rbx_types::VariantType::NumberSequence)=>{
-						let typed_value:super::number_sequence::NumberSequence=*value.as_userdata().ok_or(mlua::Error::runtime("Expected NumberSequence"))?.borrow()?;
+						let typed_value:crate::runner::number_sequence::NumberSequence=*value.as_userdata().ok_or_else(||mlua::Error::runtime("Expected NumberSequence"))?.borrow()?;
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::NumberSequence(typed_value.into()));
 					},
 					rbx_reflection::DataType::Value(rbx_types::VariantType::ColorSequence)=>{
-						let typed_value:super::color_sequence::ColorSequence=*value.as_userdata().ok_or(mlua::Error::runtime("Expected ColorSequence"))?.borrow()?;
+						let typed_value:crate::runner::color_sequence::ColorSequence=*value.as_userdata().ok_or_else(||mlua::Error::runtime("Expected ColorSequence"))?.borrow()?;
 						instance.properties.insert(index_str.to_owned(),rbx_types::Variant::ColorSequence(typed_value.into()));
 					},
 					other=>return Err(mlua::Error::runtime(format!("Unimplemented property type: {other:?}"))),
@@ -375,12 +377,13 @@ static CLASS_FUNCTION_DATABASE:CFD=phf::phf_map!{
 		"GetService"=>cf!(|lua,_this,service:mlua::String|{
 			dom_mut(lua,|dom|{
 				//dom.root_ref()==this.referent ?
-				match &*service.to_str()?{
+				let service=&*service.to_str()?;
-					"Lighting"=>{
+				match service{
-						let referent=find_first_child_of_class(dom,dom.root(),"Lighting")
+					"Lighting"|"RunService"=>{
+						let referent=find_first_child_of_class(dom,dom.root(),service)
         				.map(|instance|instance.referent())
 						.unwrap_or_else(||
-							dom.insert(dom.root_ref(),InstanceBuilder::new("Lighting"))
+							dom.insert(dom.root_ref(),InstanceBuilder::new(service))
 						);
 						Ok(Instance::new(referent))
 					},
@@ -390,21 +393,21 @@ static CLASS_FUNCTION_DATABASE:CFD=phf::phf_map!{
 		}),
 	},
 	"Terrain"=>phf::phf_map!{
-		"FillBlock"=>cf!(|_lua,_,_:(super::cframe::CFrame,Vector3,super::r#enum::Enum)|mlua::Result::Ok(()))
+		"FillBlock"=>cf!(|_lua,_,_:(crate::runner::cframe::CFrame,Vector3,crate::runner::r#enum::Enum)|mlua::Result::Ok(()))
 	},
 };
 
 /// A store of created functions for each Roblox class.
 /// Functions are created the first time they are accessed and stored in this data structure.
 #[derive(Default)]
-struct ClassFunctions{
+struct ClassMethodsStore{
 	classes:HashMap<&'static str,//ClassName
 		HashMap<&'static str,//Method name
 			mlua::Function
 		>
 	>
 }
-impl ClassFunctions{
+impl ClassMethodsStore{
 	/// return self.classes[class] or create the ClassMethods and then return it
 	fn get_or_create_class_methods(&mut self,class:&str)->Option<ClassMethods>{
 		// Use get_entry to get the &'static str keys of the database
@@ -439,6 +442,10 @@ impl ClassMethods<'_>{
 		})
 	}
 }
+fn class_methods_store_mut<T>(lua:&mlua::Lua,mut f:impl FnMut(&mut ClassMethodsStore)->mlua::Result<T>)->mlua::Result<T>{
+	let mut cf=lua.app_data_mut::<ClassMethodsStore>().ok_or_else(||mlua::Error::runtime("ClassMethodsStore missing"))?;
+	f(&mut *cf)
+}
 
 /// A virtual property pointer definition shorthand.
 type VirtualPropertyFunctionPointer=fn(&rbx_types::Variant)->Option<rbx_types::Variant>;
@@ -487,3 +494,64 @@ fn find_virtual_property(
 	//Transform Source property with provided function
 	(virtual_property.pointer)(variant)
 }
+
+// lazy-loaded per-instance userdata values
+// This whole thing is a bad idea and a garbage collection nightmare.
+// TODO: recreate rbx_dom_weak with my own instance type that owns this data.
+type CreateUserData=fn(&mlua::Lua)->mlua::Result<mlua::AnyUserData>;
+type LUD=phf::Map<&'static str,// Class name
+	phf::Map<&'static str,// Value name
+		CreateUserData
+	>
+>;
+static LAZY_USER_DATA:LUD=phf::phf_map!{
+	"RunService"=>phf::phf_map!{
+		"RenderStepped"=>|lua|{
+			lua.create_any_userdata(crate::runner::script_signal::ScriptSignal::new())
+		},
+	},
+};
+#[derive(Default)]
+pub struct InstanceValueStore{
+	values:HashMap<Ref,
+		HashMap<&'static str,
+			mlua::AnyUserData
+		>
+	>,
+}
+pub struct InstanceValues<'a>{
+	named_values:&'static phf::Map<&'static str,CreateUserData>,
+	values:&'a mut HashMap<&'static str,mlua::AnyUserData>,
+}
+impl InstanceValueStore{
+	pub fn get_or_create_instance_values(&mut self,instance:&rbx_dom_weak::Instance)->Option<InstanceValues>{
+		LAZY_USER_DATA.get(instance.class.as_str())
+			.map(|named_values|
+				InstanceValues{
+					named_values,
+					values:self.values.entry(instance.referent())
+					.or_insert_with(||HashMap::new()),
+				}
+			)
+	}
+}
+impl InstanceValues<'_>{
+	pub fn get_or_create_value(&mut self,lua:&mlua::Lua,index:&str)->mlua::Result<Option<mlua::AnyUserData>>{
+		Ok(match self.named_values.get_entry(index){
+			Some((&static_index_str,&function_pointer))=>Some(
+				match self.values.entry(static_index_str){
+					Entry::Occupied(entry)=>entry.get().clone(),
+					Entry::Vacant(entry)=>entry.insert(
+						function_pointer(lua)?
+					).clone(),
+				}
+			),
+			None=>None,
+		})
+	}
+}
+
+pub fn instance_value_store_mut<T>(lua:&mlua::Lua,mut f:impl FnMut(&mut InstanceValueStore)->mlua::Result<T>)->mlua::Result<T>{
+	let mut cf=lua.app_data_mut::<InstanceValueStore>().ok_or_else(||mlua::Error::runtime("InstanceValueStore missing"))?;
+	f(&mut *cf)
+}

src/runner/instance/mod.rs

@@ -0,0 +1,2 @@
+pub mod instance;
+pub use instance::Instance;

src/runner/mod.rs

@@ -7,7 +7,8 @@ mod color3;
 mod cframe;
 mod vector3;
 pub mod instance;
-mod number_sequence;
+mod script_signal;
 mod color_sequence;
+mod number_sequence;
 
-pub use runner::{Runner,Error};
+pub use runner::{Runner,Runnable,Error};

src/runner/runner.rs

@@ -1,4 +1,6 @@
 use crate::context::Context;
+#[cfg(feature="run-service")]
+use crate::scheduler::scheduler_mut;
 
 pub struct Runner{
 	lua:mlua::Lua,
@@ -29,11 +31,14 @@ fn init(lua:&mlua::Lua)->mlua::Result<()>{
 	//global environment
 	let globals=lua.globals();
 
+	#[cfg(feature="run-service")]
+	crate::scheduler::set_globals(lua,&globals)?;
+	super::script_signal::set_globals(lua,&globals)?;
 	super::r#enum::set_globals(lua,&globals)?;
 	super::color3::set_globals(lua,&globals)?;
 	super::vector3::set_globals(lua,&globals)?;
 	super::cframe::set_globals(lua,&globals)?;
-	super::instance::set_globals(lua,&globals)?;
+	super::instance::instance::set_globals(lua,&globals)?;
 	super::number_sequence::set_globals(lua,&globals)?;
 	super::color_sequence::set_globals(lua,&globals)?;
 
@@ -60,6 +65,8 @@ impl Runner{
 		}
 		//this makes set_app_data shut up about the lifetime
 		self.lua.set_app_data::<&'static mut rbx_dom_weak::WeakDom>(unsafe{core::mem::transmute(&mut context.dom)});
+		#[cfg(feature="run-service")]
+		self.lua.set_app_data::<crate::scheduler::Scheduler>(crate::scheduler::Scheduler::default());
 		Ok(Runnable{
 			lua:self.lua,
 			_lifetime:&std::marker::PhantomData
@@ -75,15 +82,62 @@ pub struct Runnable<'a>{
 impl Runnable<'_>{
 	pub fn drop_context(self)->Runner{
 		self.lua.remove_app_data::<&'static mut rbx_dom_weak::WeakDom>();
+		#[cfg(feature="run-service")]
+		self.lua.remove_app_data::<crate::scheduler::Scheduler>();
 		Runner{
 			lua:self.lua,
 		}
 	}
 	pub fn run_script(&self,script:super::instance::Instance)->Result<(),Error>{
-		let (name,source)=super::instance::get_name_source(&self.lua,script).map_err(Error::RustLua)?;
+		let (name,source)=super::instance::instance::get_name_source(&self.lua,script).map_err(Error::RustLua)?;
-		self.lua.globals().set("script",script).map_err(Error::RustLua)?;
+		self.lua.globals().raw_set("script",script).map_err(Error::RustLua)?;
-		self.lua.load(source.as_str())
+		let f=self.lua.load(source.as_str())
-		.set_name(name)
+		.set_name(name).into_function().map_err(Error::RustLua)?;
-		.exec().map_err(|error|Error::Lua{source,error})
+		// TODO: set_environment without losing the ability to print from Lua
+		let thread=self.lua.create_thread(f).map_err(Error::RustLua)?;
+		thread.resume::<mlua::MultiValue>(()).map_err(|error|Error::Lua{source,error})?;
+		// wait() is called from inside Lua and goes to a rust function that schedules the thread and then yields
+		// No need to schedule the thread here
+		Ok(())
+	}
+	#[cfg(feature="run-service")]
+	pub fn has_scheduled_threads(&self)->Result<bool,mlua::Error>{
+		scheduler_mut(&self.lua,|scheduler|
+			Ok(scheduler.has_scheduled_threads())
+		)
+	}
+	#[cfg(feature="run-service")]
+	pub fn game_tick(&self)->Result<(),mlua::Error>{
+		if let Some(threads)=scheduler_mut(&self.lua,|scheduler|Ok(scheduler.tick_threads()))?{
+			for thread in threads{
+				//TODO: return dt and total run time
+				let result=thread.resume::<mlua::MultiValue>((1.0/30.0,0.0))
+					.map_err(|error|Error::Lua{source:"source unavailable".to_owned(),error});
+				match result{
+					Ok(_)=>(),
+					Err(e)=>println!("game_tick Error: {e}"),
+				}
+			}
+		}
+		Ok(())
+	}
+	#[cfg(feature="run-service")]
+	pub fn run_service_step(&self)->Result<(),mlua::Error>{
+		let render_stepped=super::instance::instance::dom_mut(&self.lua,|dom|{
+			let run_service=super::instance::instance::find_first_child_of_class(dom,dom.root(),"RunService").ok_or_else(||mlua::Error::runtime("RunService missing"))?;
+			super::instance::instance::instance_value_store_mut(&self.lua,|instance_value_store|{
+				//unwrap because I trust my find_first_child_of_class function to
+				let mut instance_values=instance_value_store.get_or_create_instance_values(run_service).ok_or_else(||mlua::Error::runtime("RunService InstanceValues missing"))?;
+				let render_stepped=instance_values.get_or_create_value(&self.lua,"RenderStepped")?;
+				//let stepped=instance_values.get_or_create_value(&self.lua,"Stepped")?;
+				//let heartbeat=instance_values.get_or_create_value(&self.lua,"Heartbeat")?;
+				Ok(render_stepped)
+			})
+		})?;
+		if let Some(render_stepped)=render_stepped{
+			let signal:&super::script_signal::ScriptSignal=&*render_stepped.borrow()?;
+			signal.fire(&mlua::MultiValue::new());
+		}
+		Ok(())
 	}
 }

src/runner/script_signal.rs

@@ -0,0 +1,172 @@
+use std::{cell::RefCell,rc::Rc};
+
+use mlua::UserDataFields;
+
+#[derive(Clone)]
+struct FunctionList{
+	functions:Vec<mlua::Function>,
+}
+impl FunctionList{
+	pub fn new()->Self{
+		Self{
+			functions:Vec::new(),
+		}
+	}
+	// This eats the Lua error
+	pub fn fire(self,args:&mlua::MultiValue){
+		// Make a copy of the list in case Lua attempts to modify it during the loop
+		for function in self.functions{
+			//wee let's allocate for our function calls
+			if let Err(e)=function.call::<mlua::MultiValue>(args.clone()){
+				println!("Script Signal Error: {e}");
+			}
+		}
+	}
+}
+#[derive(Clone)]
+struct RcFunctionList{
+	functions:Rc<RefCell<FunctionList>>,
+}
+impl RcFunctionList{
+	pub fn new()->Self{
+		Self{
+			functions:Rc::new(RefCell::new(FunctionList::new())),
+		}
+	}
+	pub fn fire(&self,args:&mlua::MultiValue){
+		// Make a copy of the list in case Lua attempts to modify it during the loop
+		self.functions.borrow().clone().fire(args)
+	}
+}
+#[derive(Clone)]
+pub struct ScriptSignal{
+	// Emulate the garbage roblox api.
+	// ScriptConnection should not exist.
+	// :Disconnect should be a method on ScriptSignal, and this would be avoided entirely.
+	connections:RcFunctionList,
+	once:RcFunctionList,
+	wait:Rc<RefCell<Vec<mlua::Thread>>>,
+}
+pub struct ScriptConnection{
+	connection:RcFunctionList,
+	function:mlua::Function,
+}
+impl ScriptSignal{
+	pub fn new()->Self{
+		Self{
+			connections:RcFunctionList::new(),
+			once:RcFunctionList::new(),
+			wait:Rc::new(RefCell::new(Vec::new())),
+		}
+	}
+	pub fn fire(&self,args:&mlua::MultiValue){
+		self.connections.fire(args);
+		//Replace the FunctionList with an empty one and drop the borrow
+		let once=std::mem::replace(&mut *self.once.functions.borrow_mut(),FunctionList::new());
+		once.fire(args);
+		//resume threads waiting for this signal
+		let threads=std::mem::replace(&mut *self.wait.borrow_mut(),Vec::new());
+		for thread in threads{
+			if let Err(e)=thread.resume::<mlua::MultiValue>(args.clone()){
+				println!("Script Signal thread resume Error: {e}");
+			}
+		}
+	}
+	pub fn connect(&self,function:mlua::Function)->ScriptConnection{
+		self.connections.functions.borrow_mut().functions.push(function.clone());
+		ScriptConnection{
+			connection:self.connections.clone(),
+			function,
+		}
+	}
+	pub fn once(&self,function:mlua::Function)->ScriptConnection{
+		self.once.functions.borrow_mut().functions.push(function.clone());
+		ScriptConnection{
+			connection:self.once.clone(),
+			function,
+		}
+	}
+	pub fn wait(&self,thread:mlua::Thread){
+		self.wait.borrow_mut().push(thread);
+	}
+}
+impl ScriptConnection{
+	pub fn position(&self)->Option<usize>{
+		self.connection.functions.borrow().functions.iter().position(|function|function==&self.function)
+	}
+}
+
+impl mlua::UserData for ScriptSignal{
+	fn add_methods<M:mlua::UserDataMethods<Self>>(methods:&mut M){
+		methods.add_method("Connect",|_lua,this,f:mlua::Function|
+			Ok(this.connect(f))
+		);
+		methods.add_method("Once",|_lua,this,f:mlua::Function|
+			Ok(this.once(f))
+		);
+		// Fire is not allowed to be called from Lua
+		// methods.add_method("Fire",|_lua,this,args:mlua::MultiValue|
+		// 	Ok(this.fire(args))
+		// );
+	}
+}
+impl mlua::FromLua for ScriptSignal{
+	fn from_lua(value:mlua::Value,_lua:&mlua::Lua)->Result<Self,mlua::Error>{
+		match value{
+			mlua::Value::UserData(ud)=>Ok(ud.borrow::<Self>()?.clone()),
+			other=>Err(mlua::Error::runtime(format!("Expected {} got {:?}",stringify!(ScriptSignal),other))),
+		}
+	}
+}
+
+impl mlua::UserData for ScriptConnection{
+	fn add_fields<F:mlua::UserDataFields<Self>>(fields:&mut F){
+		fields.add_field_method_get("Connected",|_,this|{
+			Ok(this.position().is_some())
+		});
+	}
+	fn add_methods<M:mlua::UserDataMethods<Self>>(methods:&mut M){
+		methods.add_method("Disconnect",|_,this,_:()|{
+			if let Some(index)=this.position(){
+				this.connection.functions.borrow_mut().functions.remove(index);
+			}
+			Ok(())
+		});
+	}
+}
+
+fn wait_thread(lua:&mlua::Lua,this:ScriptSignal)->Result<(),mlua::Error>{
+	Ok(this.wait(lua.current_thread()))
+}
+
+// This is used to avoid calling coroutine.yield from the rust side.
+const LUA_WAIT:&str=
+"local coroutine_yield=coroutine.yield
+local wait_thread=wait_thread
+return function(signal)
+	wait_thread(signal)
+	return coroutine_yield()
+end";
+
+pub fn set_globals(lua:&mlua::Lua,globals:&mlua::Table)->Result<(),mlua::Error>{
+	let coroutine_table=globals.get::<mlua::Table>("coroutine")?;
+	let wait_thread=lua.create_function(wait_thread)?;
+
+	//create wait function environment
+	let wait_env=lua.create_table()?;
+	wait_env.raw_set("coroutine",coroutine_table)?;
+	wait_env.raw_set("wait_thread",wait_thread)?;
+
+	//construct wait function from Lua code
+	let wait=lua.load(LUA_WAIT)
+	.set_name("wait")
+	.set_environment(wait_env)
+	.call::<mlua::Function>(())?;
+
+	lua.register_userdata_type::<ScriptSignal>(|reg|{
+		reg.add_field("Wait",wait);
+		mlua::UserData::register(reg);
+	})?;
+
+	Ok(())
+}

src/scheduler.rs

@@ -0,0 +1,106 @@
+pub use tick::Tick;
+mod tick{
+	#[derive(Clone,Copy,Default,Hash,PartialEq,Eq,PartialOrd,Ord)]
+	pub struct Tick(u64);
+	impl std::ops::Add<u64> for Tick{
+		type Output=Self;
+		fn add(self,rhs:u64)->Self::Output{
+			Self(self.0+rhs)
+		}
+	}
+	impl std::ops::Sub<u64> for Tick{
+		type Output=Self;
+		fn sub(self,rhs:u64)->Self::Output{
+			Self(self.0-rhs)
+		}
+	}
+	impl std::ops::AddAssign<u64> for Tick{
+		fn add_assign(&mut self,rhs:u64){
+			self.0+=rhs;
+		}
+	}
+	impl std::ops::SubAssign<u64> for Tick{
+		fn sub_assign(&mut self,rhs:u64){
+			self.0-=rhs;
+		}
+	}
+}
+#[derive(Default)]
+pub struct Scheduler{
+	tick:Tick,
+	schedule:std::collections::HashMap<Tick,Vec<mlua::Thread>>,
+}
+
+impl Scheduler{
+	pub fn has_scheduled_threads(&self)->bool{
+		!self.schedule.is_empty()
+	}
+	pub fn schedule_thread(&mut self,delay:u64,thread:mlua::Thread){
+		self.schedule.entry(self.tick+delay.max(1))
+		.or_insert(Vec::new())
+		.push(thread);
+	}
+	pub fn tick_threads(&mut self)->Option<Vec<mlua::Thread>>{
+		self.tick+=1;
+		self.schedule.remove(&self.tick)
+	}
+}
+
+pub fn scheduler_mut<T>(lua:&mlua::Lua,mut f:impl FnMut(&mut crate::scheduler::Scheduler)->mlua::Result<T>)->mlua::Result<T>{
+	let mut scheduler=lua.app_data_mut::<crate::scheduler::Scheduler>().ok_or_else(||mlua::Error::runtime("Scheduler missing"))?;
+	f(&mut *scheduler)
+}
+
+fn schedule_thread(lua:&mlua::Lua,dt:mlua::Value)->Result<(),mlua::Error>{
+	let delay=match dt{
+		mlua::Value::Integer(i)=>i.max(0) as u64*60,
+		mlua::Value::Number(f)=>{
+			let delay=f.max(0.0)*60.0;
+			match delay.classify(){
+				std::num::FpCategory::Nan=>Err(mlua::Error::runtime("NaN"))?,
+				// cases where the number is too large to schedule
+				std::num::FpCategory::Infinite=>return Ok(()),
+				std::num::FpCategory::Normal=>if (u64::MAX as f64)<delay{
+					return Ok(());
+				},
+				_=>(),
+			}
+			delay as u64
+		},
+		mlua::Value::Nil=>0,
+		_=>Err(mlua::Error::runtime("Expected float"))?,
+	};
+	scheduler_mut(lua,|scheduler|{
+		scheduler.schedule_thread(delay.max(2),lua.current_thread());
+		Ok(())
+	})
+}
+
+// This is used to avoid calling coroutine.yield from the rust side.
+const LUA_WAIT:&str=
+"local coroutine_yield=coroutine.yield
+local schedule_thread=schedule_thread
+return function(dt)
+	schedule_thread(dt)
+	return coroutine_yield()
+end";
+
+pub fn set_globals(lua:&mlua::Lua,globals:&mlua::Table)->Result<(),mlua::Error>{
+	let coroutine_table=globals.get::<mlua::Table>("coroutine")?;
+	let schedule_thread=lua.create_function(schedule_thread)?;
+
+	//create wait function environment
+	let wait_env=lua.create_table()?;
+	wait_env.raw_set("coroutine",coroutine_table)?;
+	wait_env.raw_set("schedule_thread",schedule_thread)?;
+
+	//construct wait function from Lua code
+	let wait=lua.load(LUA_WAIT)
+	.set_name("wait")
+	.set_environment(wait_env)
+	.call::<mlua::Function>(())?;
+
+	globals.raw_set("wait",wait)?;
+
+	Ok(())
+}