Update README.md
This commit is contained in:
parent
13c718c794
commit
1b392da803
18
README.md
18
README.md
@ -68,17 +68,25 @@ print(add(2, 3))
|
||||
# Example 1: Hello world
|
||||
|
||||
```Rust
|
||||
extern crate rhai;
|
||||
use rhai::Engine;
|
||||
|
||||
fn main() {
|
||||
let mut engine = Engine::new();
|
||||
|
||||
if let Ok(result) = engine.eval("40 + 2".to_string()).unwrap().downcast::<i32>() {
|
||||
println!("Answer: {}", *result); // prints 42
|
||||
}
|
||||
}
|
||||
```
|
||||
# Example 2: Working with functions
|
||||
|
||||
Rhai's scripting engine is very lightweight. It gets its ability from the functions in your program. To call these functions, you need to register them with the scripting engine.
|
||||
|
||||
```Rust
|
||||
extern crate rhai;
|
||||
use rhai::{Engine, FnRegister};
|
||||
|
||||
fn add(x: i32, y: i32) -> i32 {
|
||||
x + y
|
||||
}
|
||||
@ -99,6 +107,11 @@ fn main() {
|
||||
Generic functions can be used in Rhai, but you'll need to register separate instances for each concrete type:
|
||||
|
||||
```Rust
|
||||
use std::fmt::Display;
|
||||
|
||||
extern crate rhai;
|
||||
use rhai::{Engine, FnRegister};
|
||||
|
||||
fn showit<T: Display>(x: &mut T) -> () {
|
||||
println!("{}", x)
|
||||
}
|
||||
@ -119,6 +132,9 @@ You can also see in this example how you can register multiple functions (or in
|
||||
Here's an more complete example of working with Rust. First the example, then we'll break it into parts:
|
||||
|
||||
```Rust
|
||||
extern crate rhai;
|
||||
use rhai::{Engine, FnRegister};
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
struct TestStruct {
|
||||
x: i32
|
||||
@ -134,6 +150,7 @@ impl TestStruct {
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let mut engine = Engine::new();
|
||||
|
||||
engine.register_type::<TestStruct>();
|
||||
@ -144,6 +161,7 @@ engine.register_type::<TestStruct>();
|
||||
if let Ok(result) = engine.eval("var x = new_ts(); x.update(); x".to_string()).unwrap().downcast::<TestStruct>() {
|
||||
println!("result: {}", result.x); // prints 1001
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
First, for each type we use with the engine, we need to be able to Clone. This allows the engine to pass by value and still keep its own state.
|
||||
|
Loading…
Reference in New Issue
Block a user