rhai/examples
2022-07-26 13:39:50 +02:00
..
definitions feat(defs): builtin definitions 2022-07-26 13:39:50 +02:00
event_handler_js Use //! for script docs. 2022-07-24 23:03:35 +08:00
event_handler_main Use //! for script docs. 2022-07-24 23:03:35 +08:00
event_handler_map Use //! for script docs. 2022-07-24 23:03:35 +08:00
arrays_and_structs.rs Add comments to examples. 2022-02-12 12:41:04 +08:00
callback.rs Expand callback example. 2022-02-16 09:12:34 +08:00
custom_types_and_methods.rs Add comments to examples. 2022-02-12 12:41:04 +08:00
hello.rs Add comments to examples. 2022-02-12 12:41:04 +08:00
README.md feat: basic definitions 2022-07-25 19:01:06 +02:00
reuse_scope.rs Add comments to examples. 2022-02-12 12:41:04 +08:00
serde.rs Add comments to examples. 2022-02-12 12:41:04 +08:00
simple_fn.rs Add comments to examples. 2022-02-12 12:41:04 +08:00
strings.rs Add comments to examples. 2022-02-12 12:41:04 +08:00
threading.rs Add comments to examples. 2022-02-12 12:41:04 +08:00

Sample Applications

Standard Examples

Example Description
arrays_and_structs shows how to register a Rust type and using it with arrays
callback shows how to store a Rhai closure and call it later within Rust
custom_types_and_methods shows how to register a Rust type and methods/getters/setters for it
hello simple example that evaluates an expression and prints the result
reuse_scope evaluates two pieces of code in separate runs, but using a common Scope
serde example to serialize and deserialize Rust types with serde (requires the serde feature)
simple_fn shows how to register a simple Rust function
strings shows different ways to register Rust functions taking string arguments
threading shows how to communicate with an Engine running in a separate thread via an MPSC channel
definitions shows how to generate definition files for manual inspection or for use with Rhai LSP, requires the metadata feature

Scriptable Event Handler With State Examples

Because of its popularity, included are sample implementations for the pattern Scriptable Event Handler With State in different styles.

Example Handler Script Description
event_handler_main event_handler_main/script.rhai Main Style
event_handler_js event_handler_js/script.rhai JS Style
event_handler_map event_handler_map/script.rhai Map Style

Running Examples

Examples can be run with the following command:

cargo run --example {example_name}