99 lines
4.7 KiB
Markdown
99 lines
4.7 KiB
Markdown
|
The Rhai Scripting Language
|
||
|
|
==========================
|
||
|
|
|
||
|
|
1. [What is Rhai](about.md)
|
||
|
|
1. [Features](about/features.md)
|
||
|
|
2. [Supported Targets and Builds](about/targets.md)
|
||
|
|
3. [What Rhai Doesn't Do](about/non-design.md)
|
||
|
|
4. [Related Resources](about/related.md)
|
||
|
|
2. [Getting Started](start.md)
|
||
|
|
1. [Install the Rhai Crate](start/install.md)
|
||
|
|
2. [Optional Features](start/features.md)
|
||
|
|
3. [Special Builds](start/builds.md)
|
||
|
|
1. [Performance Build](start/builds/performance.md)
|
||
|
|
2. [Minimal Build](start/builds/minimal.md)
|
||
|
|
3. [`no-std` Build](start/builds/no-std.md)
|
||
|
|
4. [WebAssembly (WASM)](start/builds/wasm.md)
|
||
|
|
4. [Examples](start/examples.md)
|
||
|
|
1. [Rust](start/examples/rust.md)
|
||
|
|
2. [Scripts](start/examples/scripts.md)
|
||
|
|
3. [Using the `Engine`](engine.md)
|
||
|
|
1. [Hello World in Rhai - Evaluate a Script](engine/hello-world.md)
|
||
|
|
2. [Compile a Script to AST for Repeated Evaluations](engine/compile.md)
|
||
|
|
3. [Call a Rhai Function from Rust](engine/call-fn.md)
|
||
|
|
4. [Create a Rust Anonymous Function from a Rhai Function](engine/func.md)
|
||
|
|
5. [Evaluate Expressions Only](engine/expressions.md)
|
||
|
|
6. [Raw `Engine`](engine/raw.md)
|
||
|
|
4. [Extend Rhai with Rust](rust.md)
|
||
|
|
1. [Traits](rust/traits.md)
|
||
|
|
2. [Register a Rust Function](rust/functions.md)
|
||
|
|
1. [`String` Parameters in Rust Functions](rust/strings.md)
|
||
|
|
3. [Register a Generic Rust Function](rust/generic.md)
|
||
|
|
4. [Register a Fallible Rust Function](rust/fallible.md)
|
||
|
|
5. [Packages](rust/packages.md)
|
||
|
|
6. [Override a Built-in Function](rust/override.md)
|
||
|
|
7. [Operator Overloading](rust/operators.md)
|
||
|
|
8. [Register a Custom Type and its Methods](rust/custom.md)
|
||
|
|
1. [Getters and Setters](rust/getters-setters.md)
|
||
|
|
2. [Indexers](rust/indexers.md)
|
||
|
|
3. [Disable Custom Types](rust/disable-custom.md)
|
||
|
|
4. [Printing Custom Types](rust/print-custom.md)
|
||
|
|
9. [`Scope` - Initializing and Maintaining State](rust/scope.md)
|
||
|
|
10. [Engine Configuration Options](rust/options.md)
|
||
|
|
5. [Rhai Language Reference](language.md)
|
||
|
|
1. [Comments](language/comments.md)
|
||
|
|
2. [Values and Types](language/values-and-types.md)
|
||
|
|
1. [`Dynamic` Values](language/dynamic.md)
|
||
|
|
2. [`type-of`](language/type-of.md)
|
||
|
|
3. [Numbers](language/numbers.md)
|
||
|
|
1. [Operators](language/num-op.md)
|
||
|
|
2. [Functions](language/num-fn.md)
|
||
|
|
3. [Value Conversions](language/convert.md)
|
||
|
|
4. [Strings and Characters](language/strings-chars.md)
|
||
|
|
1. [Built-in Functions](language/string-fn.md)
|
||
|
|
5. [Arrays](language/arrays.md)
|
||
|
|
6. [Object Maps](language/object-maps.md)
|
||
|
|
1. [Parse from JSON](language/json.md)
|
||
|
|
7. [Time-Stamps](language/timestamps.md)
|
||
|
|
3. [Keywords](language/keywords.md)
|
||
|
|
4. [Statements](language/statements.md)
|
||
|
|
5. [Variables](language/variables.md)
|
||
|
|
6. [Constants](language/constants.md)
|
||
|
|
7. [Logic Operators](language/logic.md)
|
||
|
|
8. [If Statement](language/if.md)
|
||
|
|
9. [While Loop](language/while.md)
|
||
|
|
10. [Loop Statement](language/loop.md)
|
||
|
|
11. [For Loop](language/for.md)
|
||
|
|
12. [Return Values](language/return.md)
|
||
|
|
13. [Throw Exception on Error](language/throw.md)
|
||
|
|
14. [Functions](language/functions.md)
|
||
|
|
1. [Function Overloading](language/overload.md)
|
||
|
|
2. [Call Method as Function](language/method.md)
|
||
|
|
15. [Print and Debug](language/print-debug.md)
|
||
|
|
16. [Modules](language/modules.md)
|
||
|
|
1. [Export Variables and Functions](language/modules/export.md)
|
||
|
|
2. [Import Modules](language/modules/import.md)
|
||
|
|
3. [Create from Rust](language/modules/rust.md)
|
||
|
|
4. [Create from `AST`](language/modules/ast.md)
|
||
|
|
5. [Module Resolvers](language/modules/resolvers.md)
|
||
|
|
6. [Safety and Protection](safety.md)
|
||
|
|
1. [Checked Arithmetic](safety/checked.md)
|
||
|
|
2. [Sand-Boxing](safety/sandbox.md)
|
||
|
|
3. [Maximum Length of Strings](safety/max-string-size.md)
|
||
|
|
4. [Maximum Size of Arrays](safety/max-array-size.md)
|
||
|
|
5. [Maximum Size of Object Maps](safety/max-map-size.md)
|
||
|
|
6. [Maximum Number of Operations](safety/max-operations.md)
|
||
|
|
1. [Tracking Progress and Force-Termination](safety/progress.md)
|
||
|
|
7. [Maximum Number of Modules](safety/max-modules.md)
|
||
|
|
8. [Maximum Call Stack Depth](safety/max-call-stack.md)
|
||
|
|
9. [Maximum Statement Depth](safety/max-stmt-depth.md)
|
||
|
|
7. [Advanced Topics](advanced.md)
|
||
|
|
1. [Script Optimization](engine/optimize.md)
|
||
|
|
1. [Optimization Levels](engine/optimize/optimize-levels.md)
|
||
|
|
2. [Re-Optimize an AST](engine/optimize/reoptimize.md)
|
||
|
|
3. [Eager Function Evaluation](engine/optimize/eager.md)
|
||
|
|
4. [Side-Effect Considerations](engine/optimize/side-effects.md)
|
||
|
|
5. [Volatility Considerations](engine/optimize/volatility.md)
|
||
|
|
6. [Subtle Semantic Changes](engine/optimize/semantics.md)
|
||
|
|
2. [Eval Statement](language/eval.md)
|