SA-MP Forums

SA-MP Forums (https://forum.sa-mp.com/index.php)
-   Plugin Development (https://forum.sa-mp.com/forumdisplay.php?f=18)
-   -   [Tool/Web/Other] Rust SA:MP SDK (https://forum.sa-mp.com/showthread.php?t=651131)

EvaBaka 14/03/2018 10:39 AM

Rust SA:MP SDK
 
It's a Rust library allows you to write plugins in Rust.

Features
Hides most of type coercion. You don't need make a cell type as a String or other things yourself.

Macros:
  • new_plugin! that defines a plugin and exports functions.
  • define_native! defines a native and parses arguments.
  • log! calls logprinft funciton.
  • natives! makes a vec of your natives.
  • get_string! and get_array! convert pointers to a slice or a String.
  • set_string! sets a string to an AMX by a physical address.

Make a new plugin
Code:

struct Plugin {
    version: &'static str,
    amx_count: u32,
}

impl Plugin {
    fn load(&self) -> bool {
        log!("Plugin is loaded. Version: {}", self.version);
        return true;
    }

    fn amx_load(&mut self, amx: &AMX) -> Cell {
        let natives = natives![
            { "MyFunction", my_function }
        ];

        match amx.register(natives) {
            Ok(_) => log!("Natives are successful loaded"),
            Err(err) => log!("Whoops, there is an error {:?}", err),
        }

        self.amx_count += 1;

        AMX_ERR_NONE
    }

    fn amx_unload(&mut self, _: &AMX) -> Cell {
        self.amx_count -= 1;

        AMX_ERR_NONE
    }

    fn my_function(&self, _amx: &AMX, player_id: i32) -> AmxResult<Cell> {
        Ok(-player_id)
    }
}

impl Default for Plugin {
    fn default() -> Self {
        Plugin {
            version: "0.1",
            amx_count: 0,
        }
    }
}

new_plugin!(Plugin);

// Also you can make a plugin with ProcessTick support.
new_plugin!(Plugin with process_tick)

Define a native function.
Hides arguments parsing inside the macro.

All you need are to define a method function_name in your new plugin with given arguments.

Code:

// native: FunctionName(int_arg, &float_arg);
define_native!(function_name, int_arg: i32, float_ref_arg: ref f32);

// native: WithoutArguments();
define_native(function_name);

Call natives and public functions.
Code:

// Broadcast to all subscribers that a user have changed his name.
fn notify(&self, amx: AMX, player_id: u32, old_name: String, new_name: String) -> AmxResult<Cell> {
    exec_public!(amx, "OnPlayerNameChanged"; player_id, old_name => string, new_name => string)
}

Documentation and examples
Here is documentation and there is an example plugin (Memcached library) and here is a more simple example.

Repository
https://github.com/ZOTTCE/samp-sdk

Ask your questions and more popular will be in wiki on GitHub.

Sia 14/03/2018 10:54 AM

Re: Rust SA:MP SDK
 
Nice proga SDK plygin

YourShadow 14/03/2018 07:25 PM

Re: Rust SA:MP SDK
 
Very good.

Kaperstone 14/03/2018 11:42 PM

Re: Rust SA:MP SDK
 
Awesome!

KayJ 15/03/2018 01:11 AM

Re: Rust SA:MP SDK
 
Nice

SyS 15/03/2018 01:21 AM

Re: Rust SA:MP SDK
 
Nice :)

Zeth 15/03/2018 09:01 AM

Re: Rust SA:MP SDK
 
Amazing!

KashCherry 15/03/2018 10:41 AM

Re: Rust SA:MP SDK
 
Nice 8)

NaS 15/03/2018 11:03 AM

Re: Rust SA:MP SDK
 
Nice, definitely going to try it out.

PT 15/03/2018 01:07 PM

Re: Rust SA:MP SDK
 
It’s very interesting this plugin

Nice work


All times are GMT. The time now is 01:43 AM.

Powered by vBulletin® Version 3.8.6
Copyright ©2000 - 2018, Jelsoft Enterprises Ltd.