Jump to content

SampSharp - Write game modes in .NET


Banditul

Recommended Posts

spacer.png

Discord

SampSharp is a plugin and library which allows you to write SA-MP game modes in C#. The plugin works both on Linux and Windows. The library contains various classes for every type of resource available in SA-MP (players, vehicles, textdraws, etc). Aside from this wrapper around native functions, the library also contains a good structure to build your gamemode on. This plugin was initially released in 2014, and has received a good ever since and I'm still available for any questions related to this plugin.

SampSharp provides two structures for developing game modes. SampSharp.GameMode and SampSharp.Entities.

SampSharp.GameMode provides a simple object-oriented structure for developing your game mode. All callbacks are forwarded to the implementation of BaseMode and vanilla callbacks are forwarded as events to the related instances (eg. OnPlayerText fires the PlayerText event on the related Player instance). A simple code sample can be found below.

public class GameMode : BaseMode
{
    protected override void OnPlayerConnected(BasePlayer player, EventArgs e)
    {
        base.OnPlayerConnected(player, e);

        player.SendClientMessage($"Welcome {player.Name}, to a whole new world!");
    }

    [Command("spawn")]
    public static void VehicleCommand(BasePlayer player, VehicleModelType model)
    {
        Console.WriteLine($"Spawning a {model} for {player.Name}");
        var vehicle = GtaVehicle.Create(model, player.Position + new Vector3(0, 0, 0.5f), player.Rotation.Z);
        player.PutInVehicle(vehicle);
        player.SendClientMessage(Color.GreenYellow, $"You have spawned a {model}!");
    }
} 

SampSharp.Entities (only available since early 2020) provides an Entity-Component-System structure with full dependency injection support for developing your game mode. SampSharp.Entities is still in active development but is already stable and usable. Below, a similar code sample can be found:

public class SampleSystem : ISystem
    {
        [Event]
        public void OnPlayerConnected(Player player)
        {
            player.SendClientMessage($"Welcome {player.Name}, to a whole new world!");
        }

        [PlayerCommand("spawn")]
        public static void VehicleCommand(Player player, VehicleModelType model, IWorldService worldService)
        {
            Console.WriteLine($"Spawning a {model} for {player.Name}");
            var vehicle = worldService.CreateVehicle(model, player.Position + new Vector3(0, 0, 0.5f), player.Rotation.Z, -1, -1);
            player.PutInVehicle(vehicle);
            player.SendClientMessage(Color.GreenYellow, $"You have spawned a {model}!");
        }
    } 

Download

https://github.com/ikkentim/SampSharp/releases

Documentation

Our documentation website is still in development and some vital documentation is still lacking. If you need any assistance, feel free to join our Discord server!

https://sampsharp.net

  • Thanks 1
Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...

Important Information

We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue. For more details you can also review our Terms of Use and Privacy Policy.