jaroslaw/bevy_scriptum
1
0
Fork 0
Code Issues Pull requests 2 Projects Releases Packages Wiki Activity Actions

fix docs
Some checks failed
Book / test (pull_request) Has been cancelled
Details
Rust / build (pull_request) Has been cancelled
Details

Browse source
This commit is contained in:
Jaroslaw Konik 2025-05-27 17:55:16 +02:00
parent c6f52bdc8d
commit bf9c94b7f0
3 changed files with 23 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
book/src/SUMMARY.md
View file

@ -2,30 +2,29 @@
- [Introduction](./introduction.md) - [Introduction](./introduction.md)
- [Runtimes](./runtimes.md) - [Runtimes](./runtimes.md)
- [Lua](./lua/lua.md) - [Lua](./lua/lua.md)
- [Installation](./lua/installation.md) - [Installation](./lua/installation.md)
- [Hello World](./lua/hello_world.md) - [Hello World](./lua/hello_world.md)
- [Spawning scripts](./lua/spawning_scripts.md) - [Spawning scripts](./lua/spawning_scripts.md)
- [Calling Rust from Lua](./lua/calling_rust_from_script.md) - [Calling Rust from Lua](./lua/calling_rust_from_script.md)
- [Calling Lua from Rust](./lua/calling_script_from_rust.md) - [Calling Lua from Rust](./lua/calling_script_from_rust.md)
- [Interacting with bevy in callbacks](./lua/interacting_with_bevy.md) - [Interacting with bevy in callbacks](./lua/interacting_with_bevy.md)
- [Builtin types](./lua/builtin_types.md) - [Builtin types](./lua/builtin_types.md)
- [Builtin variables](./lua/builtin_variables.md) - [Builtin variables](./lua/builtin_variables.md)
- [Ruby](./ruby/ruby.md) - [Ruby](./ruby/ruby.md)
- [Installation](./ruby/installation.md) - [Installation](./ruby/installation.md)
- [Hello World](./ruby/hello_world.md) - [Hello World](./ruby/hello_world.md)
- [Spawning scripts](./ruby/spawning_scripts.md) - [Spawning scripts](./ruby/spawning_scripts.md)
- [Calling Rust from Ruby](./ruby/calling_rust_from_script.md) - [Calling Rust from Ruby](./ruby/calling_rust_from_script.md)
- [Calling Ruby from Rust](./ruby/calling_script_from_rust.md) - [Calling Ruby from Rust](./ruby/calling_script_from_rust.md)
- [Interacting with bevy in callbacks](./ruby/interacting_with_bevy.md) - [Interacting with bevy in callbacks](./ruby/interacting_with_bevy.md)
- [Builtin types](./ruby/builtin_types.md) - [Builtin types](./ruby/builtin_types.md)
- [Builtin variables](./ruby/builtin_variables.md) - [Rhai](./rhai/rhai.md)
- [Rhai](./rhai/rhai.md) - [Installation](./rhai/installation.md)
- [Installation](./rhai/installation.md) - [Hello World(TBD)]()
- [Hello World(TBD)]()
- [Multiple plugins](./multiple_plugins.md) - [Multiple plugins](./multiple_plugins.md)
- [Multiple runtimes(TBD)]() - [Multiple runtimes(TBD)]()
- [Implementing custom runtimes(TBD)]() - [Implementing custom runtimes(TBD)]()
- [Workflow](./workflow/workflow.md) - [Workflow](./workflow/workflow.md)
- [Live-reload](./workflow/live_reload.md) - [Live-reload](./workflow/live_reload.md)
- [Bevy support matrix](./bevy_support_matrix.md) - [Bevy support matrix](./bevy_support_matrix.md)

2
book/src/ruby/builtin_types.md
View file

@ -55,6 +55,8 @@ fn set_translation(
## Bevy::Entity ## Bevy::Entity
`Bevy::Entity.current` is currently not available within promise callbacks.
### Constructor ### Constructor
None - instances can only be acquired by using `Bevy::Entity.current` None - instances can only be acquired by using `Bevy::Entity.current`

12
book/src/ruby/builtin_variables.md
View file

@ -1,13 +1 @@
# Builtin variables # Builtin variables
## entity
Current entity that the script is atteched to can be retrieved by calling `Bevy::Entity.current`.
It exposes `index` method that returns bevy entity index.
It is useful for accessing entity's components from scripts.
It can be used in the following way:
```ruby
puts("Current entity index: #{Bevy::Entity.current.index}")
```
`Bevy::Entity.current` variable is currently not available within promise callbacks.