Commands and Exports

Commands and Exports — Dog Walker Job | Quasar Store | Quasar Store

The player's level

lua

local level, experience, required = exports['qs-dogwalker']:getPlayerLevel()
-- level       current dog walker level
-- experience  experience toward the next level
-- required    experience the next level needs

The configured locations

lua

local locations = exports['qs-dogwalker']:getLocations()   -- Config.Locations, as configured

for id, location in ipairs(locations) do
    print(id, location.dog_name, location.owner_name, location.employer_coords)
end

Useful for a map, a phone app or a GPS that points players at the owners.

Refreshing the statistics

lua

exports['qs-dogwalker']:openLeaderboard()

-- or by event, from the client or the server
TriggerEvent('qs-dogwalker:openLeaderboard')
TriggerClientEvent('qs-dogwalker:openLeaderboard', source)

Fetches the three rankings, the countdowns and the last winners, and sends them to the Statistics view. That view lives inside the dog panel, so it is seen while the player has the panel open.

IsPlayerOnMission

True while the player has at least one walk open. This is the name the other Quasar jobs export, so it is the one to use in a new integration.

lua

if exports['qs-dogwalker']:IsPlayerOnMission(source) then
    return -- busy walking a dog
end

isPlayerOnDuty

The same question under its older name, kept for scripts that already call it.

lua

local walking = exports['qs-dogwalker']:isPlayerOnDuty(source)

getOnDutyCount

How many players are walking at least one dog right now — for a job centre, a city stats screen or a scoreboard.

lua

local walkers = exports['qs-dogwalker']:getOnDutyCount()

getPlayerLevel

Any player's dog walker level, read from the database the first time and cached after.

lua

local level, experience, required = exports['qs-dogwalker']:getPlayerLevel(source)

if level >= 10 then
    -- e.g. unlock a pet shop discount for experienced walkers
end

Showing a message in the job's style

Sends a notification through the same system the job uses — its own notifications, or your SendTextMessage when Config.DefaultNotifications is off.

lua

-- server side
TriggerClientEvent('qs-dogwalker:sendNotification', source, 'notify', 'success', 'Good job today!')

-- type: 'success' · 'error' · 'warning' · 'info'

Commands#

Client Exports#

Commands and Exports

Commands#

Client Exports#

Server Exports#

Events#

About the Messages#