Skip to content

feat: allow the conversion of lua functions into ScriptValue via DynamicScriptFunction #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 28, 2025
Merged

feat: allow the conversion of lua functions into ScriptValue via DynamicScriptFunction #396

merged 1 commit into from
Mar 28, 2025

Conversation

makspll
Copy link
Owner

@makspll makspll commented Mar 28, 2025

Summary

Because mlua::Function's store a pointer to their lua context, it's possible to call these functions without direct access to a lua context. This allows us to convert a lua function into a DynamicScriptFunction which can be marshalled as a ScriptValue and arbitrarilly stored on the rust side. However this will cause issues if your script contexts get unloaded, in the form of panics most likely

@makspll makspll enabled auto-merge (squash) March 28, 2025 18:00
@github-actions GitHub Actions
Copy link
Contributor

🐰 Bencher Report

Branchfeat/storing-lua-callbacks-as-script-value
Testbedlinux-gha
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
nanoseconds (ns)
(Result Δ%)		Upper Boundary
nanoseconds (ns)
(Limit %)
component/access Lua📈 view plot
🚷 view threshold		5,628.20 ns
(+6.76%)Baseline: 5,272.01 ns
6,818.01 ns
(82.55%)
component/access Rhai📈 view plot
🚷 view threshold		6,685.50 ns
(-2.98%)Baseline: 6,890.82 ns
8,414.85 ns
(79.45%)
component/get Lua📈 view plot
🚷 view threshold		2,754.90 ns
(-3.70%)Baseline: 2,860.61 ns
3,404.18 ns
(80.93%)
component/get Rhai📈 view plot
🚷 view threshold		4,668.80 ns
(-3.05%)Baseline: 4,815.65 ns
6,074.45 ns
(76.86%)
conversions/Mut::from📈 view plot
🚷 view threshold		270.80 ns
(+29.56%)Baseline: 209.02 ns
354.63 ns
(76.36%)
conversions/Ref::from📈 view plot
🚷 view threshold		230.32 ns
(+15.47%)Baseline: 199.46 ns
333.30 ns
(69.10%)
conversions/ScriptValue::List📈 view plot
🚷 view threshold		750.33 ns
(-0.45%)Baseline: 753.76 ns
937.78 ns
(80.01%)
conversions/ScriptValue::Map📈 view plot
🚷 view threshold		2,032.10 ns
(+7.84%)Baseline: 1,884.31 ns
2,673.43 ns
(76.01%)
conversions/ScriptValue::Reference::from_into📈 view plot
🚷 view threshold		44.53 ns
(+2.85%)Baseline: 43.29 ns
49.34 ns
(90.25%)
conversions/Val::from_into📈 view plot
🚷 view threshold		384.02 ns
(+2.29%)Baseline: 375.43 ns
545.29 ns
(70.43%)
function/call 4 args Lua📈 view plot
🚷 view threshold		1,909.00 ns
(-5.87%)Baseline: 2,027.97 ns
2,245.30 ns
(85.02%)
function/call 4 args Rhai📈 view plot
🚷 view threshold		1,692.30 ns
(-4.71%)Baseline: 1,775.90 ns
1,995.10 ns
(84.82%)
function/call Lua📈 view plot
🚷 view threshold		261.58 ns
(-2.90%)Baseline: 269.39 ns
292.33 ns
(89.48%)
function/call Rhai📈 view plot
🚷 view threshold		464.84 ns
(-9.27%)Baseline: 512.33 ns
644.25 ns
(72.15%)
math/vec mat ops Lua📈 view plot
🚷 view threshold		7,649.80 ns
(-1.41%)Baseline: 7,759.19 ns
9,534.49 ns
(80.23%)
math/vec mat ops Rhai📈 view plot
🚷 view threshold		7,051.00 ns
(-3.88%)Baseline: 7,335.57 ns
8,530.46 ns
(82.66%)
query/10 entities Lua📈 view plot
🚷 view threshold		29,742.00 ns
(+18.12%)Baseline: 25,179.47 ns
31,610.79 ns
(94.09%)
query/10 entities Rhai📈 view plot
🚷 view threshold		24,923.00 ns
(+3.77%)Baseline: 24,017.53 ns
28,562.32 ns
(87.26%)
query/100 entities Lua📈 view plot
🚷 view threshold		45,529.00 ns
(-9.50%)Baseline: 50,308.80 ns
62,537.86 ns
(72.80%)
query/100 entities Rhai📈 view plot
🚷 view threshold		42,345.00 ns
(+2.96%)Baseline: 41,128.60 ns
50,786.77 ns
(83.38%)
query/1000 entities Lua📈 view plot
🚷 view threshold		320,990.00 ns
(+2.13%)Baseline: 314,287.33 ns
402,273.70 ns
(79.79%)
query/1000 entities Rhai📈 view plot
🚷 view threshold		262,380.00 ns
(+6.52%)Baseline: 246,328.00 ns
320,496.55 ns
(81.87%)
reflection/10 Lua📈 view plot
🚷 view threshold		6,310.80 ns
(-5.37%)Baseline: 6,669.05 ns
7,932.85 ns
(79.55%)
reflection/10 Rhai📈 view plot
🚷 view threshold		15,624.00 ns
(-3.82%)Baseline: 16,245.13 ns
18,252.21 ns
(85.60%)
reflection/100 Lua📈 view plot
🚷 view threshold		50,523.00 ns
(-2.64%)Baseline: 51,893.13 ns
58,619.00 ns
(86.19%)
reflection/100 Rhai📈 view plot
🚷 view threshold		675,990.00 ns
(-1.89%)Baseline: 689,037.33 ns
808,253.49 ns
(83.64%)
resource/access Lua📈 view plot
🚷 view threshold		4,784.60 ns
(+3.73%)Baseline: 4,612.69 ns
5,799.56 ns
(82.50%)
resource/access Rhai📈 view plot
🚷 view threshold		5,895.10 ns
(-6.13%)Baseline: 6,279.99 ns
7,992.08 ns
(73.76%)
resource/get Lua📈 view plot
🚷 view threshold		2,244.10 ns
(-5.53%)Baseline: 2,375.34 ns
2,826.20 ns
(79.40%)
resource/get Rhai📈 view plot
🚷 view threshold		4,035.70 ns
(-5.29%)Baseline: 4,261.27 ns
5,556.21 ns
(72.63%)
🐰 View full continuous benchmarking report in Bencher

@makspll makspll disabled auto-merge March 28, 2025 19:23
@makspll makspll merged commit 158cde2 into main Mar 28, 2025
23 checks passed
@makspll makspll deleted the feat/storing-lua-callbacks-as-script-value branch March 28, 2025 19:23
@github-actions github-actions bot mentioned this pull request Mar 28, 2025
Merged
makspll added a commit that referenced this pull request Mar 29, 2025
@github-actions @makspll
chore: release (#384)
f20698e 
## 🤖 New release

* `bevy_mod_scripting_derive`: 0.10.0 -> 0.11.0
* `bevy_mod_scripting_core`: 0.10.0 -> 0.11.0 (✓ API compatible changes)
* `bevy_mod_scripting_lua`: 0.10.0 -> 0.11.0 (✓ API compatible changes)
* `bevy_mod_scripting_rhai`: 0.10.0 -> 0.11.0 (✓ API compatible changes)
* `bevy_mod_scripting_functions`: 0.10.0 -> 0.11.0 (✓ API compatible
changes)
* `ladfile`: 0.4.0 -> 0.5.0 (⚠ API breaking changes)
* `mdbook_lad_preprocessor`: 0.1.4 -> 0.1.5 (✓ API compatible changes)
* `ladfile_builder`: 0.2.6 -> 0.3.0 (⚠ API breaking changes)
* `bevy_mod_scripting`: 0.10.0 -> 0.11.0 (✓ API compatible changes)

### ⚠ `ladfile` breaking changes

```text
--- failure constructible_struct_adds_field: externally-constructible struct adds field ---

Description:
A pub struct constructible with a struct literal has a new pub field. Existing struct literals must be updated to include the new field.
        ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/constructible_struct_adds_field.ron

Failed in:
  field LadType.generated in /tmp/.tmpI1fySQ/bevy_mod_scripting/crates/ladfile/src/lib.rs:458
  field LadType.insignificance in /tmp/.tmpI1fySQ/bevy_mod_scripting/crates/ladfile/src/lib.rs:465

--- failure method_parameter_count_changed: pub method parameter count changed ---

Description:
A publicly-visible method now takes a different number of parameters.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#fn-change-arity
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/method_parameter_count_changed.ron

Failed in:
  ladfile::LadFile::get_type_identifier now takes 3 parameters instead of 2, in /tmp/.tmpI1fySQ/bevy_mod_scripting/crates/ladfile/src/lib.rs:55
```

### ⚠ `ladfile_builder` breaking changes

```text
--- failure constructible_struct_adds_field: externally-constructible struct adds field ---

Description:
A pub struct constructible with a struct literal has a new pub field. Existing struct literals must be updated to include the new field.
        ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/constructible_struct_adds_field.ron

Failed in:
  field LadFileSettings.exclude_types_containing_unregistered in /tmp/.tmpI1fySQ/bevy_mod_scripting/crates/ladfile_builder/src/plugin.rs:42

--- failure method_parameter_count_changed: pub method parameter count changed ---

Description:
A publicly-visible method now takes a different number of parameters.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#fn-change-arity
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/method_parameter_count_changed.ron

Failed in:
  ladfile_builder::plugin::ScriptingDocgenPlugin::new now takes 4 parameters instead of 3, in /tmp/.tmpI1fySQ/bevy_mod_scripting/crates/ladfile_builder/src/plugin.rs:61
```

<details><summary><i><b>Changelog</b></i></summary><p>

## `bevy_mod_scripting_derive`

<blockquote>

##
[0.11.0](bevy_mod_scripting_derive-v0.10.0...bevy_mod_scripting_derive-v0.11.0)
- 2025-03-29

### Added

- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))
</blockquote>

## `bevy_mod_scripting_core`

<blockquote>

##
[0.11.0](bevy_mod_scripting_core-v0.10.0...bevy_mod_scripting_core-v0.11.0)
- 2025-03-29

### Added

- optimize access map
([#395](#395))
- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- improve tracing spans, add `profile_with_tracy` feature flag
([#394](#394))
- add `profile_with_tracy` feature which plays nicely with bevy's
`bevy/trace_tracy` feature
([#393](#393))
- Add initial benchmarks, integrate them into CI & add getters/settters
for `Scripts` resource
([#381](#381))
- add ScriptValue override for printing opaque values
([#380](#380))
- ✨ Dynamic Script Components, `register_new_component`
binding, `remove_component` no longer requires `ReflectComponent` data
([#379](#379))
- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))

### Fixed

- fix global type cache not containing generic types
([#388](#388))

### Other

- switch to hashbrown hashmap in the function registry
([#399](#399))
- try play with hashing for access maps
([#398](#398))
- allow check creation for bencher
</blockquote>

## `bevy_mod_scripting_lua`

<blockquote>

##
[0.11.0](bevy_mod_scripting_lua-v0.10.0...bevy_mod_scripting_lua-v0.11.0)
- 2025-03-29

### Added

- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- allow the conversion of lua functions into `ScriptValue` via
`DynamicScriptFunction`
([#396](#396))
- Add initial benchmarks, integrate them into CI & add getters/settters
for `Scripts` resource
([#381](#381))
- ✨ Dynamic Script Components, `register_new_component`
binding, `remove_component` no longer requires `ReflectComponent` data
([#379](#379))
</blockquote>

## `bevy_mod_scripting_rhai`

<blockquote>

##
[0.11.0](bevy_mod_scripting_rhai-v0.10.0...bevy_mod_scripting_rhai-v0.11.0)
- 2025-03-29

### Added

- [**breaking**] bump bersion
- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- Add initial benchmarks, integrate them into CI & add getters/settters
for `Scripts` resource
([#381](#381))
</blockquote>

## `bevy_mod_scripting_functions`

<blockquote>

##
[0.11.0](bevy_mod_scripting_functions-v0.10.0...bevy_mod_scripting_functions-v0.11.0)
- 2025-03-29

### Added

- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- ✨ Dynamic Script Components, `register_new_component`
binding, `remove_component` no longer requires `ReflectComponent` data
([#379](#379))
- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))
</blockquote>

## `ladfile`

<blockquote>

##
[0.5.0](v0.4.0-ladfile...v0.5.0-ladfile)
- 2025-03-29

### Added

- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))
</blockquote>

## `mdbook_lad_preprocessor`

<blockquote>

##
[0.1.5](v0.1.4-mdbook_lad_preprocessor...v0.1.5-mdbook_lad_preprocessor)
- 2025-03-29

### Added

- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))

### Fixed

- make all links in the mdbook preprocessor relative
([#392](#392))
- mdbook preprocessor links not taking into account root url
([#391](#391))
</blockquote>

## `ladfile_builder`

<blockquote>

##
[0.3.0](v0.2.6-ladfile_builder...v0.3.0-ladfile_builder)
- 2025-03-29

### Added

- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))
</blockquote>

## `bevy_mod_scripting`

<blockquote>

##
[0.11.0](v0.10.0...v0.11.0)
- 2025-03-29

### Added

- allow the conversion of lua functions into `ScriptValue` via
`DynamicScriptFunction`
([#396](#396))
- improve tracing spans, add `profile_with_tracy` feature flag
([#394](#394))
- add `profile_with_tracy` feature which plays nicely with bevy's
`bevy/trace_tracy` feature
([#393](#393))
- Add initial benchmarks, integrate them into CI & add getters/settters
for `Scripts` resource
([#381](#381))
- ✨ Dynamic Script Components, `register_new_component`
binding, `remove_component` no longer requires `ReflectComponent` data
([#379](#379))
- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- optimize access map
([#395](#395))
- add ScriptValue override for printing opaque values
([#380](#380))
- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))
- [**breaking**] bump bersion

### Fixed

- fix global type cache not containing generic types
([#388](#388))

### Other

- switch to hashbrown hashmap in the function registry
([#399](#399))
- try play with hashing for access maps
([#398](#398))
- allow check creation for bencher
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Maksymilian Mozolewski <makspl17@gmail.com>
This was referenced Mar 29, 2025
Merged
Merged
makspll pushed a commit that referenced this pull request Mar 30, 2025
@github-actions
chore: release (#402)
c3b50fb 
## 🤖 New release

* `bevy_mod_scripting_derive`: 0.11.0 -> 0.11.1
* `bevy_system_reflection`: 0.1.0 -> 0.1.1 (✓ API compatible changes)
* `bevy_mod_scripting_core`: 0.11.0 -> 0.11.1 (✓ API compatible changes)
* `bevy_mod_scripting_lua`: 0.11.0 -> 0.11.1 (✓ API compatible changes)
* `bevy_mod_scripting_rhai`: 0.11.0 -> 0.11.1 (✓ API compatible changes)
* `bevy_mod_scripting_functions`: 0.11.0 -> 0.11.1 (✓ API compatible
changes)
* `ladfile_builder`: 0.3.0 -> 0.3.1 (✓ API compatible changes)
* `bevy_mod_scripting`: 0.11.0 -> 0.11.1 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

## `bevy_mod_scripting_derive`

<blockquote>

##
[0.11.0](bevy_mod_scripting_derive-v0.10.0...bevy_mod_scripting_derive-v0.11.0)
- 2025-03-29

### Added

- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))
</blockquote>


## `bevy_mod_scripting_core`

<blockquote>

##
[0.11.0](bevy_mod_scripting_core-v0.10.0...bevy_mod_scripting_core-v0.11.0)
- 2025-03-29

### Added

- optimize access map
([#395](#395))
- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- improve tracing spans, add `profile_with_tracy` feature flag
([#394](#394))
- add `profile_with_tracy` feature which plays nicely with bevy's
`bevy/trace_tracy` feature
([#393](#393))
- Add initial benchmarks, integrate them into CI & add getters/settters
for `Scripts` resource
([#381](#381))
- add ScriptValue override for printing opaque values
([#380](#380))
- ✨ Dynamic Script Components, `register_new_component`
binding, `remove_component` no longer requires `ReflectComponent` data
([#379](#379))
- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))

### Fixed

- fix global type cache not containing generic types
([#388](#388))

### Other

- switch to hashbrown hashmap in the function registry
([#399](#399))
- try play with hashing for access maps
([#398](#398))
- allow check creation for bencher
</blockquote>

## `bevy_mod_scripting_lua`

<blockquote>

##
[0.11.0](bevy_mod_scripting_lua-v0.10.0...bevy_mod_scripting_lua-v0.11.0)
- 2025-03-29

### Added

- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- allow the conversion of lua functions into `ScriptValue` via
`DynamicScriptFunction`
([#396](#396))
- Add initial benchmarks, integrate them into CI & add getters/settters
for `Scripts` resource
([#381](#381))
- ✨ Dynamic Script Components, `register_new_component`
binding, `remove_component` no longer requires `ReflectComponent` data
([#379](#379))
</blockquote>

## `bevy_mod_scripting_rhai`

<blockquote>

##
[0.11.0](bevy_mod_scripting_rhai-v0.10.0...bevy_mod_scripting_rhai-v0.11.0)
- 2025-03-29

### Added

- [**breaking**] bump bersion
- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- Add initial benchmarks, integrate them into CI & add getters/settters
for `Scripts` resource
([#381](#381))
</blockquote>

## `bevy_mod_scripting_functions`

<blockquote>

##
[0.11.0](bevy_mod_scripting_functions-v0.10.0...bevy_mod_scripting_functions-v0.11.0)
- 2025-03-29

### Added

- optimize `get` and `set` functions, add `MagicFunctions` sub-registry
([#397](#397))
- ✨ Dynamic Script Components, `register_new_component`
binding, `remove_component` no longer requires `ReflectComponent` data
([#379](#379))
- overhaul mdbook preprocessor, prettify generated docs, support dummy
globals ([#377](#377))
</blockquote>

## `ladfile_builder`

<blockquote>

##
[0.3.1](v0.3.0-ladfile_builder...v0.3.1-ladfile_builder)
- 2025-03-29

### Added

- bump bevy to 0.15.3
([#401](#401))
</blockquote>

## `bevy_mod_scripting`

<blockquote>

##
[0.11.1](v0.11.0...v0.11.1)
- 2025-03-29

### Added

- bump bevy to 0.15.3
([#401](#401))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This was referenced Mar 31, 2025
Merged
Open
This was referenced Apr 10, 2025
Open
Open
This was referenced Apr 20, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@makspll