Server API

Every export below is server-side. Call them on exports.road_minigolf.

Courses

GetCourses

All courses with their full data, props included.

table

id -> course. Large: prefer GetCourseList when you only need names and numbers.

local courses = exports.road_minigolf:GetCourses()

GetCourse

One course with its full data.

string

required

The course ID

table | nil

The course, or nil when the ID does not exist.

local course = exports.road_minigolf:GetCourse('demo_skygarden')

GetCourseList

A light list of every course, without props, sorted by ID.

table

Show entry

string

Course ID

string

Course name

boolean

true when the course is published

string

Who created it

number

Number of playable holes

number

Total par

table | nil

{ x, y, z, h } of the start point

number

Saved version of the course

for _, c in ipairs(exports.road_minigolf:GetCourseList()) do
    print(c.id, c.name, c.holes, c.par, c.enabled)
end

Players and sessions

IsPlayerInGame

number

required

Player server ID

boolean

true while the player’s game is running (not in a lobby that has not started yet).

if exports.road_minigolf:IsPlayerInGame(source) then
    -- don't open the phone camera now
end

GetPlayerSession

The game or lobby the player is in.

number

required

Player server ID

table | nil

Public session info, or nil when the player is in no game or lobby.

Show fields

string

Session ID

string

Course ID

string

Course name

number

Server ID of the host

string

'lobby', 'playing' or 'finished'

boolean

true for a solo round

string

'free' (everyone at once) or 'turns'

table

The players with name, colour, ball, strokes, current hole and total

number

Lobby size

number

Number of holes

table

Par per hole

number

Stroke limit per hole

number

Seconds per hole, 0 = off

number

Entry fee

local session = exports.road_minigolf:GetPlayerSession(source)
if session and session.state == 'playing' then
    print(('%s plays %s'):format(GetPlayerName(source), session.courseName))
end

GetActiveSessions

Every running game and open lobby.

table

Show entry

string

Session ID

string

Course ID

string

'lobby', 'playing' or 'finished'

string

'free' or 'turns'

boolean

false when the host changed the rules

number

Unix time of the start, 0 while in the lobby

table

{ { id, identifier, name }, ... }

local sessions = exports.road_minigolf:GetActiveSessions()
print(('%d minigolf sessions running'):format(#sessions))

IsAdmin

Whether a player has minigolf admin rights.

number

required

Player server ID

boolean

Player server IDs only: nil, strings, 0 (console) and negative numbers return false.

if exports.road_minigolf:IsAdmin(source) then
    -- show admin options
end

Leaderboards and statistics

GetLeaderboard

The all-time leaderboard of a course.

string

required

The course ID

number

default:"10"

Number of rows

table

Rows, best first. Empty when the course does not exist.

Show row

string

Player name

number

Total strokes of the round

number

Total par of the course

number

Unix time of the round

local top = exports.road_minigolf:GetLeaderboard('demo_skygarden', 5)
for i, row in ipairs(top) do
    print(i, row.name, row.strokes)
end

GetLeaderboards

All three leaderboards of a course.

string

required

The course ID

number

default:"10"

Number of rows per board

table

{ all = rows, month = rows, week = rows } with the same rows as GetLeaderboard.

local boards = exports.road_minigolf:GetLeaderboards('demo_skygarden', 3)
local best = boards.week[1]

GetHoleRecords

The record of every hole.

string

required

The course ID

table

One entry per hole: { strokes, name }. strokes = 0 means no record yet.

for hole, rec in ipairs(exports.road_minigolf:GetHoleRecords('demo_skygarden')) do
    if rec.strokes > 0 then print(hole, rec.name, rec.strokes) end
end

GetPlayerStats

Statistics of an online player.

number

required

Player server ID

table | nil

nil when the player is offline or never played.

Show fields

string

Last name used

number

Rounds played

number

Games won

number

Holes-in-one

number

Holes played

number

Strokes in total

number

Unix time of the last round

local stats = exports.road_minigolf:GetPlayerStats(source)
if stats then print(stats.rounds, stats.holesInOne) end

GetPlayerStatsByIdentifier

The same as GetPlayerStats, for offline players.

string

required

The identifier the events on this page carry: the framework’s player identifier, or the FiveM license without a framework

local stats = exports.road_minigolf:GetPlayerStatsByIdentifier(identifier)

Events

All server events are local events: listen with AddEventHandler. Clients cannot trigger them. New arguments are always added at the end, so existing handlers keep working after updates.

Games

AddEventHandler('road_minigolf:server:gameStarted', function(sessionId, courseId, players, ranked)
    -- players = { { id, identifier, name }, ... }
end)

AddEventHandler('road_minigolf:server:gameFinished', function(sessionId, courseId, payload, players)
    -- payload.results = { { id, name, total, rank, strokes = { ... }, holed, record, personalBest, previousBest, reward, rewardBlocked }, ... }
    -- players = { { id, identifier, name, total, rank }, ... }
end)

Identifiers are only in the players argument. The payload is the same table the clients get, so it never carries identifiers.

Records

AddEventHandler('road_minigolf:server:holeInOne', function(src, courseId, holeIndex, identifier) end)
AddEventHandler('road_minigolf:server:recordSet', function(src, identifier, courseId, strokes, name) end)
AddEventHandler('road_minigolf:server:holeRecordSet', function(src, identifier, courseId, holeIndex, strokes, name) end)

Money

AddEventHandler('road_minigolf:server:entryFeePaid', function(src, identifier, amount, courseId, sessionId) end)
AddEventHandler('road_minigolf:server:entryFeeRefunded', function(src, identifier, amount, courseId, sessionId) end)
AddEventHandler('road_minigolf:server:rewardPaid', function(src, identifier, amount, courseId, sessionId) end)

Anti-cheat

AddEventHandler('road_minigolf:server:suspicious', function(src, identifier, reason, data)
    -- reason: 'implausible_hole', 'hole_unreachable' or 'ball_speed'
    -- data: courseId, sessionId, hole and details
end)

Flags never punish on their own. The OpenHooks.OnSuspicious hook in server/open.lua gets the same call.

Admin actions

src is 0 when the action came from the server console.

Event	Arguments
`road_minigolf:server:courseSaved`	`src, courseId, revision, layoutChanged, identifier, name`
`road_minigolf:server:courseDeleted`	`src, courseId, identifier, name`
`road_minigolf:server:courseImported`	`src, courseId, identifier, name`
`road_minigolf:server:courseExported`	`src, courseId, identifier, fileName`
`road_minigolf:server:scoresReset`	`src, courseId, identifier, name`
`road_minigolf:server:scoreRemoved`	`src, courseId, identifier, name`
`road_minigolf:server:coursesReloaded`	`src, identifier, count, changed`
`road_minigolf:server:sessionEnded`	`src, sessionId, identifier`

identifier is the admin’s identifier. name is the course name.

AddEventHandler('road_minigolf:server:courseSaved', function(src, courseId, revision, layoutChanged)
    if layoutChanged then
        print(('Course %s changed its layout, the leaderboard starts over'):format(courseId))
    end
end)

API documentation

RoadVR

RoadPhone Pro

RoadPhone

RoadPad

RoadCarRadio

Road Minigolf

RoadPark

Server API

Server API

Courses

GetCourses

GetCourse

GetCourseList

Players and sessions

IsPlayerInGame

GetPlayerSession

GetActiveSessions

IsAdmin

Leaderboards and statistics

GetLeaderboard

GetLeaderboards

GetHoleRecords

GetPlayerStats

GetPlayerStatsByIdentifier

Events

Games

Records

Money

Anti-cheat

Admin actions

​Server API

​Courses

​GetCourses

​GetCourse

​GetCourseList

​Players and sessions

​IsPlayerInGame

​GetPlayerSession

​GetActiveSessions

​IsAdmin

​Leaderboards and statistics

​GetLeaderboard

​GetLeaderboards

​GetHoleRecords

​GetPlayerStats

​GetPlayerStatsByIdentifier

​Events

​Games

​Records

​Money

​Anti-cheat

​Admin actions

Server API

Courses

GetCourses

GetCourse

GetCourseList

Players and sessions

IsPlayerInGame

GetPlayerSession

GetActiveSessions

IsAdmin

Leaderboards and statistics

GetLeaderboard

GetLeaderboards

GetHoleRecords

GetPlayerStats

GetPlayerStatsByIdentifier

Events

Games

Records

Money

Anti-cheat

Admin actions