DiscordBot/functions.json

{
    "say":{
        "title":"say (%player, %channel, %message[, %sound]);",
        "description":"",
        "fields":[
            {
                "name":"%player",
                "value":"This part specifies who gets the message. This can also be replaced with 'everyone'"
            },
            {
                "name":"%channel",
                "value":"This part is the channel that the text uses for using the chat window."
            },
            {
                "name":"%message",
                "value":"What to send to the player(s)."
            },
            {
                "name":"%sound",
                "value":"[Optiona Parameter] This part is the sound file (.wav) that you want to play along with the message."
            }
        ]
    },
    "order":{
        "title":"order( %vehicleId, command, [bool | %obj] )",
        "description":"Rawr",
        "fields":[
            {
                "name":"%vehicleId",
                "value":"The vehicle to be ordered"
            },
            {
                "name":"command",
                "value":"the command to issue"
            },
            {
                "name":"[bool | %obj]",
                "value":"%obj to interact with, or bool for confirmation"
            }
        ]
    },
    "setposition":{
        "title":"setPosition(%objectId, %xPos, %yPos, %xPos[, %zRot[, %xRot]]);",
        "description":"Relocates an object to a new place, with optional facing directions",
        "fields":[
            {
                "name":"%objectId",
                "value":"The object you wish to set the position of."
            },
            {
                "name":"%xPos",
                "value":"The X coordinate."
            },
            {
                "name":"%yPos",
                "value":"The Y coordinate."
            },
            {
                "name":"%zPos",
                "value":"The X coordinate."
            },
            {
                "name":"%zRot",
                "value":"[Optiona Parameter] What direction the %objectId will end up facing."
            },
            {
                "name":"%xRot",
                "value":"[Optiona Parameter]"
            }
        ]
    },
    "healobject":{
        "title":"healObject(%objectId, %amount);",
        "description":"Give (or take) health to (from) an object or vehicle",
        "fields":[
            {
                "name":"%objectId",
                "value":"The object you wish to adjust the health of."
            },
            {
                "name":"%amount",
                "value":"Amount of health to bestow upon %objectId. Negative numbers will result in damages."
            }
        ]
    },
    "messagebox":{
        "title":"messageBox(%playerId, %message);",
        "description":"Show a message box to a player",
        "fields":[
            {
                "name":"%playerId",
                "value":"The player to send the message alert to."
            },
            {
                "name":"%message",
                "value":"The message to display in the alert."
            }
        ]
    },
    "reloadobject":{
        "title":"reloadObject(%vehicleId, %amount);",
        "description":"Reloads a vehicle.",
        "fields":[
            {
                "name":"%vehicleId",
                "value":"The vehicle to send the ammo to."
            },
            {
                "name":"%amount",
                "value":"Increases ammo count by this amount, negative numbers will deplete ammo reserves.\n(5 regular ammo = 1 blast cannon ammo)"
            }
        ]
    },
    "setteam":{
        "title":"reloadObject(%objectId, *IDSTR_TEAM_<TEAM>);",
        "description":"Changes the team of the given object.",
        "fields":[
            {
                "name":"%objectId",
                "value":"The vehicle or object we're changing the team of."
            },
            {
                "name":"*IDSTR_TEAM_<TEAM>",
                "value":"Valid Options: *IDSTR_TEAM_YELLOW, *IDSTR_TEAM_BLUE, *IDSTR_TEAM_RED, *IDSTR_TEAM_PURPLE, *IDSTR_TEAM_NEUTRAL"
            }
        ]
    },
    "blast":{
        "title":"blast(%objectId, %radius, %damage);",
        "description":"Creates a blast zone centered on the object given.",
        "fields":[
            {
                "name":"%objectId",
                "value":"The object at the core of the blast radius."
            },
            {
                "name":"%radius",
                "value":"Size of the blast."
            },
            {
                "name":"%damage",
                "value":"The amount of damage to cause with the blast."
            }
        ]
    },
    "gethudname":{
        "title":"getHudName(%vehicleId);",
        "description":"Returns the name of an object",
        "fields":[
            {
                "name":"%vehicleId",
                "value":"The object that we want to get the name of."
            }
        ]
    }
}