3.1.   Getting Started: An Example

Every Slayer game mode is defined using a template that contains information such as the name, default preferences, and teams.

Here is an example game mode definition:

new ScriptGroup(Slayer_GameModeTemplateSG)
{
        // Game mode settings
        className = "ExampleGameMode";
        uiName = "Example Mode";
        useTeams = true;
        // disable_teamCreation = true;

        // Team settings
        // teams_minTeams = 2;
        // teams_maxTeams = 4;

        // Default minigame settings
        default_title = "Slayer Example";
        default_weaponDamage = false;

        // Locked minigame settings
        locked_playerDatablock = nameToID("PlayerStandardArmor");
        locked_lives = 10;
        locked_weaponDamage = true;
        locked_teams_allySameColors = false;
        locked_chat_enableTeamChat = false;

        // Teams
        new ScriptObject()
        {
                // Prevent team from being deleted
                disable_delete = true;
                disable_edit = false;

                // Default team settings
                default_botFillLimit = 5;

                // Locked team settings
                locked_name = "Red";
                locked_lives = 5;
                locked_color = 0;
                locked_sort = true;
        };

        new ScriptObject()
        {
                // Prevent team from being deleted
                disable_delete = false;
                disable_edit = false;

                // Default team settings
                default_name = "Blue";

                // Locked team settings
                locked_color = 3;
                locked_sort = false;
                locked_syncLoadout = true;
        };

        new ScriptObject()
        {
                disable_edit = true;
                disable_delete = true;
                default_name = "Green";
                default_color = 2;
        };
};

Let's walk through the above example. The first line specifies that this object is a ScriptGroup of class "Slayer_GameModeTemplateSG".

Next, we see some "game mode settings". These fields are required for every game mode.

• 'className' is a unique class name that will be used in callbacks for this game mode.
• 'uiName' is the name that players will see.
• 'useTeams' specifies whether this is a team-based game mode.

Default minigame settings can be set using "default_*" fields. These settings are set the given values when the game mode starts, but a user may change them at any time.

Locked minigame settings, denoted by "locked_*" are the same as default settings, except that they cannot be changed by the user. It is recommended that locked settings be used sparingly - give the user as much flexibility as possible!

Default teams can be created by creating ScriptObjects inside the game mode template. Team preferences follow the same conventions as game mode preferences.

Additional minigame preferences may be found at Appendix B: Minigame Preferences List, and team preferences may be found at Appendix C: Team Preferences List.

3.2.   Game Mode Callbacks

Slayer contains many callbacks that allow game modes to alter game-play. To view a list of callbacks, see the "gamemode-callbacks.html" file in this folder.

The basic structure of a callback looks like this:

// This function will be called when the game mode starts.
function YourGameModeClassName::onGameModeStart(%this)
{
        // %this is the game mode object, used for storing game mode information.
        // Each instance of the game mode will have a separate game mode object.
        // Get the minigame:
        %minigame = %this.minigame;
        echo("Started gamemode" SPC %this SPC "in minigame" SPC %minigame @ ".");
}

Refer to Appendix A: Game Mode Callbacks Reference to fully customize game-play.

6.1.   Appendix A: Game Mode Callbacks Reference

This is a list of all included game mode callbacks and their arguments. More detail, including descriptions and return values, is available in the "doc" folder of Gamemode_Slayer.zip. This table is meant to be a quick reference, not a complete guide.

6.2.   Appendix B: Minigame Preferences List

This is a list of all default Slayer preferences. Variables that are not prefixed by a dollar sign ($) are minigame member fields.

6.3.   Appendix C: Team Preferences List

This is a list of all default team preferences.

6.4.   Appendix D: Permission Levels

Slayer permission levels are enumerated by "$Slayer::PermissionLevel*" variables. Possible permission levels include:

• Slayer::PermissionLevel["Host"] - Only the host.
• Slayer::PermissionLevel["SuperAdmin"] - Super admins and above.
• Slayer::PermissionLevel["Admin"] - Admins and above.
• Slayer::PermissionLevel["Owner"] - The owner of the minigame and above.
• Slayer::PermissionLevel["OwnerFullTrust"] - Those with the owner's full trust and above.
• Slayer::PermissionLevel["OwnerBuildTrust"] - Those with the owner's build trust and above.
• Slayer::PermissionLevel["Any"] - Any client with minigame edit permissions.