Exports (API Communication)

All Functions only accessible at server side

Good to know: You can use all functions as event or manupulation of the logic

Functions

Send a notify

Example (1)

exports["RocketSoccer"]:Notify(source, message)

Parameters (1)

Name	Type
source	int
message	string

Start a round

Example (2)

exports["RocketSoccer"]:StartRound(sourceOrange, sourceBlue)

Parameters (2)

Name	Type
sourceOrange	int
sourceBlue	int

Manipulation (2)

If the return of the function is false, the round will not start, but if it is true, it will.

Stop a round

Example (3)

exports["RocketSoccer"]:StopRound()

Manipulation (3)

If the return of the function is false, the round will not stop, but if it is true, it will.

Get a player name

Example (4)

exports["RocketSoccer"]:GetPlayerName(source)

Parameters (4)

Name	Type
source	int

Manipulation (4)

Change the return of the function to a different name (this will be displayed in the DUI)

Return (4)

The respective player name (Changeable by "Manipulation")

Check if player is allowed to join the queue

Example (5)

exports["RocketSoccer"]:IsPlayerAllowed(source)

Parameters (5)

Name	Type
source	int

Manipulation (5)

If true is returned, the player can be added to the respective queue.

Note that you have to add the player to the queue yourself:

queue[team][source] = true

Return (5)

true or false

Add a player to the queue

Example (6)

exports["RocketSoccer"]:AddPlayerToQueue(source, team, force, player)

Parameters (6)

Name	Type
source	int
team	string (blue or orange)
force	boolean
player	int (discord user id)

Manipulation (6)

The return is only relevant for further processing of the function.

The actual logic is:

queue[team][source] = true / false

Return (6)

true or false

Check if player is in the queue of a team

Example (7)

exports["RocketSoccer"]:IsPlayerInQueue(source)

Parameters (7)

Name	Type
source	int

Manipulation (7)

Change the return of the function to change the logic:

true / false

Return (7)

true or false

Remove a player from the queue

Example (8)

exports["RocketSoccer"]:RemovePlayerFromQueue(source, player)

Parameters (8)

Name	Type
source	int
player	int (discord user id)

Manipulation (8)

The following line is the deciding logic which a player removes.

Modify these lines to detect manipulation

queue.blue[source] = nil
queue.orange[source] = nil

Get the current round

Example (9)

exports["RocketSoccer"]:GetCurrentRound()

Return (9)

If no round is started, the return value is nil

Otherwise the round model is returned

{
    type = 0, -- 0 = Starting - 1 = In Game
    time = Settings.Round.Wait,
    url = Settings.Logo,
    ball = object,
    players = {
        orange = {
            source = playerOrange,
            ped = GetPlayerPed(playerOrange),
            vehicle = carOrange,
            name = Settings.API.GetPlayerName(playerOrange),
            score = 0
        },
        blue = {
            source = playerBlue,
            ped = GetPlayerPed(playerBlue),
            vehicle = carBlue,
            name = Settings.API.GetPlayerName(playerBlue),
            score = 0
        }
    }
}

Spawn a vehicle

Example (10)

exports["RocketSoccer"]:CreateVehicle(model, vector)

Parameters (10)

Name	Type
model	int / string
vector	table (vector3)

Manipulation (10)

Change the following line to return a different variable on return.

This can help if there are problems with an anticheat.

Note that the correct data type must be returned (see Return Tab).

return CreateVehicle(model, vector, true, false)

Return (10)

An entity of the type Vehicle is returned

Spawn a object

Example (11)

exports["RocketSoccer"]:CreateObject(model, vector)

Parameters (11)

Name	Type
model	int / string
vector	table (vector3)

Manipulation (11)

Change the following line to return a different variable on return.

This can help if there are problems with an anticheat.

Note that the correct data type must be returned (see Return Tab).

return CreateObject(model, vector, true, false, false)

Return (11)

An entity of the type Object is returned

Events

OnExploit

Explanation (12)

Called when trying to tune up your vehicle using the internal trigger and it is not a Rocket Soccer vehicle.

Parameters (12)

Name	Type
playerPedId	int (Ped)
netID	int (Network ID)

OnWinning

Explanation (13)

Called when the round ends.

Reasons:

• Time expired

• A team leaves the server

Parameters (13)

team	string (blue or orange)

OnGoal

Explanation (14)

Called when a team scores a goal

Parameters (14)

team	string (blue or orange)