samp 0.1.2

Tools to develop SA:MP plugins
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! samp is a tool to develop plugins for [samp](http://sa-mp.com) servers written in rust.
//!
//! # project structure
//! * `samp` is a glue between crates described below (that's what you need).
//! * `samp-codegen` generates raw `extern "C"` functions and does whole nasty job.
//! * `samp-sdk` contains all types to work with amx.
//!
//! # usage
//! * [install](https://rustup.rs) rust compiler (supports only `i686` os versions because of samp server arch).
//! * add in your `Cargo.toml` this:
//! ```toml
//! [lib]
//! crate-type = ["cdylib"] # or dylib
//!
//! [dependencies]
//! samp = "0.2.5"
//! ```
//! * write your first plugin
//!
//! # examples
//! * simple memcache plugin in `plugin-example` folder.
//! * your `lib.rs` file
//! ```rust,compile_fail
//! use samp::prelude::*; // export most useful types
//! use samp::{native, initialize_plugin}; // codegen macros
//!
//! struct Plugin;
//!
//! impl SampPlugin for Plugin {
//!     // this function executed when samp server loads your plugin
//!     fn on_load(&mut self) {
//!         println!("Plugin is loaded.");
//!     }
//! }
//!
//! impl Plugin {
//!     #[native(name = "TestNative")]
//!     fn my_native(&mut self, _amx: &Amx, text: AmxString) -> AmxResult<bool> {
//!         let text = text.to_string(); // convert amx string into rust string
//!         println!("rust plugin: {}", text);
//!
//!         Ok(true)
//!     }
//! }
//!
//! initialize_plugin!(
//!     natives: [Plugin::my_native],
//!     {
//!         let plugin = Plugin; // create a plugin object
//!         return plugin; // return the plugin into runtime
//!     }
//! );
//! ```

pub mod amx;
#[doc(hidden)]
pub mod interlayer;
pub mod plugin;
pub(crate) mod runtime;

pub use samp_codegen::{initialize_plugin, native};
pub use samp_sdk::{args, cell, consts, error, exports, raw};
pub use samp_sdk::{exec_public}; // macros

#[cfg(feature = "encoding")]
pub use samp_sdk::encoding;

pub mod prelude {
    //! Most used imports.
    pub use crate::amx::{Amx, AmxExt};
    pub use crate::cell::{AmxCell, AmxString, Buffer, Ref, UnsizedBuffer};
    pub use crate::error::AmxResult;
    pub use crate::plugin::SampPlugin;
}