SeanOMik
/
lyra-engine
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

Create an early scripting engine #2

Merged
SeanOMik merged 42 commits from feature/early-scripting into main 2024-03-03 03:28:57 +00:00
Conversation 0 Commits 42 Files Changed 100 +6958 -1170
SeanOMik commented 2024-03-03 02:50:54 +00:00
Owner
Copy Link

This pr adds a working Lua scripting engine. The engine is capable of reloading the scripts on a change, loading 3d models, spawning entities, moving them around, and even responding to keyboard input. Not everything is exposed to Lua yet, I need to figure out some easier ways to do it since currently its a massive pain and completely manual.

To be able to support scripts, other features were added to other crates, like asset change watching, and staged system execution, among many other things that I didn't keep track of. I tried to use mlua as the Lua library, but found it limiting so ended up just making my own: elua (short for "easy lua").

Loading a Lua script:

game.with_plugin(LuaScriptingPlugin);

// loading the script
let world = game.world_mut();
let mut res_man = world.get_resource_mut::<ResourceManager>();
let script = res_man.request::<LuaScript>("scripts/test.lua").unwrap();
res_man.watch("scripts/test.lua", false).unwrap();
drop(res_man);

// Adding the script to the world.
let script = Script::new("test.lua", script);
let scripts = ScriptList::new(vec![script]);
world.spawn((scripts,));

Every system tick the scripts will be executed. The scripting engine loads the Lua script and looks for functions in it with the name of on_<stage>, and will execute those functions on the ECS stage. The stages that are built into the engine are already supported by the scripting engine. So the function names in order of execution are, on_init, on_first, on_pre_update, on_update, on_post_update, on_last.

On the execution of each script, globals are set so the programmer can make changes to the world. The ECS world is exposed as world, and the entity that the script is on is exposed as entity.

Brief overview of World

Exposed methods:

  • request_res: Used to request assets.
  • add_resource: Used to add a resource to the ECS world.
  • resource: Used to get resources from the ECS world.
  • view: Used to view into the ECS world and query for components. 
    world:view(function (t)
    -- Do things
end, Transform)
    • The parameters of the method are system: Function(...comps) -> ...comps, ...comps
    • The second parameter is the requested components
    • The first parameter is the system that is provided the requested components through the parameters of the system. If the system makes any changes to the components, it must return them for the changes to take affect. The order doesn't matter.

Brief overview of Scripting Engine

The scripting engine exposes APIs through "Providers". The providers can register types to Lua. These types can be wrappers of Rust types (e.g., LuaModelComponent, LuaActionHandler, etc.), be converted to and from Lua types (e.g., LuaDeltaTime), or converted to and from Lua tables (no types use this currently, it was discovered to be slower than wrapped types). View the extension trait RegisterLuaType for World to see all the ways that types can be exposed to Lua.

This pr adds a working Lua scripting engine. The engine is capable of reloading the scripts on a change, loading 3d models, spawning entities, moving them around, and even responding to keyboard input. Not everything is exposed to Lua yet, I need to figure out some easier ways to do it since currently its a massive pain and completely manual. To be able to support scripts, other features were added to other crates, like asset change watching, and staged system execution, among many other things that I didn't keep track of. I tried to use [`mlua`](https://github.com/mlua-rs/mlua) as the Lua library, but found it limiting so ended up just making my own: [`elua`](https://git.seanomik.net/seanomik/elua) (short for "easy lua"). ### Loading a Lua script: ```rust game.with_plugin(LuaScriptingPlugin); // loading the script let world = game.world_mut(); let mut res_man = world.get_resource_mut::<ResourceManager>(); let script = res_man.request::<LuaScript>("scripts/test.lua").unwrap(); res_man.watch("scripts/test.lua", false).unwrap(); drop(res_man); // Adding the script to the world. let script = Script::new("test.lua", script); let scripts = ScriptList::new(vec![script]); world.spawn((scripts,)); ``` Every system tick the scripts will be executed. The scripting engine loads the Lua script and looks for functions in it with the name of `on_<stage>`, and will execute those functions on the ECS stage. The stages that are built into the engine are already supported by the scripting engine. So the function names in order of execution are, `on_init`, `on_first`, `on_pre_update`, `on_update`, `on_post_update`, `on_last`. On the execution of each script, globals are set so the programmer can make changes to the world. The ECS world is exposed as `world`, and the entity that the script is on is exposed as `entity`. ### Brief overview of World Exposed methods: * `request_res`: Used to request assets. * `add_resource`: Used to add a resource to the ECS world. * `resource`: Used to get resources from the ECS world. * `view`: Used to view into the ECS world and query for components. ```lua world:view(function (t) -- Do things end, Transform) ``` - The parameters of the method are `system: Function(...comps) -> ...comps, ...comps` - The second parameter is the requested components - The first parameter is the system that is provided the requested components through the parameters of the system. If the system makes any changes to the components, it must return them for the changes to take affect. The order doesn't matter. ### Brief overview of Scripting Engine The scripting engine exposes APIs through "Providers". The providers can register types to Lua. These types can be wrappers of Rust types (e.g., `LuaModelComponent`, `LuaActionHandler`, etc.), be converted to and from Lua types (e.g., `LuaDeltaTime`), or converted to and from Lua tables (no types use this currently, it was discovered to be slower than wrapped types). View the extension trait `RegisterLuaType` for World to see all the ways that types can be exposed to Lua.
SeanOMik added 42 commits 2024-03-03 02:50:55 +00:00
eb44aba3dc
reflect: Fix weird panics for rust-analyzer 
Not sure why they were happening. These panics didn't happen on CI and my machine when building and running the tests.
639ec0ee42
resource: fix resource manager tests 
A test was failing since 'watch_image' was deleting the file and recreating it while the other test was running
SeanOMik merged commit 71693971c2 into main 2024-03-03 03:28:57 +00:00
SeanOMik deleted branch feature/early-scripting 2024-03-03 03:28:57 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Kind/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

No Label
Kind/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: SeanOMik/lyra-engine#2
No description provided.
Delete Branch "feature/early-scripting"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?