Skip to content

Commit ee64a3a

Browse files
committed
fix up more docs
1 parent 239b385 commit ee64a3a

File tree

4 files changed

+7
-3
lines changed

4 files changed

+7
-3
lines changed

docs/src/Summary/controlling-script-bindings.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ some_type:hello_world("hi from method!");
5757
hello_world2("hi from global!");
5858
```
5959

60+
Note the `new_unregistered` call instead of `new`, this is because `GlobalNamespace` is not a `Reflect` type, and the `new` call also automatically registers the type in the reflection registry.
61+
6062
## Context Arguments
6163

6264
Each script function call always receives an additional context argument: `FunctionCallContext`.

docs/src/Summary/customizing-script-contexts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ let plugin = SomeScriptingPlugin::default().add_runtime_initializer(|runtime: &m
4545
});
4646
```
4747

48+
In the case of Lua, the runtime type is `()` i.e. This is because `mlua` does not have a separate runtime concept.
49+
4850
## Accessing the World in Initializers
4951

5052
You can access the world in these initializers by using the thread local: `ThreadWorldContainer`:

docs/src/Summary/managing-scripts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ DeleteScript::<LuaScriptingPlugin>::new("my_script.lua".into())
4949
replace `LuaScriptingPlugin` with the scripting plugin you are using.
5050

5151
## Loading/Unloading timeframe
52-
Scripts are processed via commands, so any asset events will be processed at the next command execution point running after BMS internal asset systems.
52+
Scripts asset events are processed within the same frame they are issued. This means the moment an asset is loaded, it should be loaded and ready to use in the `Update` schedule. Similarly, the moment an asset is deleted, it should be unloaded and no longer usable in the `Update` schedule.

readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ The languages currently supported are as follows:
3838
|Luajit|
3939
|Luajit52|
4040
|Luau|
41-
|~~Rhai~~ temporarilly on hold[^1]|
41+
|Rhai|
4242
|~~Rune~~ temporarilly on hold[^1]|
4343

4444
## Documentation
4545

4646
For examples, installation and usage instructions see our shiny new [book](https://makspll.github.io/bevy_mod_scripting)
4747

48-
[^1]: Due to the recent re-write of the crate, documentation generation as well as rhai and rune support are temporarilly on hold. They will likely be re-implemented in the future. `Rhai` in particualar is difficult to re-implement due to a lack of support for first-class-functions.
48+
[^1]: Due to the recent re-write of the crate, documentation generation as well as rune support are temporarilly on hold. They will likely be re-implemented in the future.
4949

5050
[^2]: the coverage does not include generated bindings.
5151

0 commit comments

Comments
 (0)