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

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

Start a round

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

Stop a round

exports["RocketSoccer"]:StopRound()

Get a player name

exports["RocketSoccer"]:GetPlayerName(source)

Check if player is allowed to join the queue

exports["RocketSoccer"]:IsPlayerAllowed(source)

Add a player to the queue

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

Check if player is in the queue of a team

exports["RocketSoccer"]:IsPlayerInQueue(source)

Remove a player from the queue

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

Get the current round

exports["RocketSoccer"]:GetCurrentRound()

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

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

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)

Spawn a object

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

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)

Events

OnExploit

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

OnWinning

Called when the round ends.

Reasons:

Time expired
A team leaves the server

OnGoal

Called when a team scores a goal

PreviousRocket Soccer NextControls

Last updated 1 year ago

hashtagFunctions

hashtagSend a notify

hashtagStart a round

hashtagStop a round

hashtagGet a player name

hashtagCheck if player is allowed to join the queue

hashtagAdd a player to the queue

hashtagCheck if player is in the queue of a team

hashtagRemove a player from the queue

hashtagGet the current round

hashtagSpawn a vehicle

hashtagSpawn a object

hashtagEvents

hashtagOnExploit

hashtagOnWinning

hashtagOnGoal