Commands & Exports

This section lists all available commands, exports, and events included in the script. You’ll find client-side, server-side, and shared functions designed to help developers integrate, extend, or interact with the system easily within their own scripts or frameworks.

---

Commands

This section lists all available commands included in the script. Each command is designed to simplify administration, player interaction, or debugging tasks. You’ll find detailed descriptions, usage examples, and permission requirements to help you manage and customize your server efficiently.

Command	Description
/setmotelowner	Command to set motel owner, editable in config.lua.
/createmotel	Command to create motel, editable in config.lua.
/editmotel	Command to edit motel, editable in config.lua.
/deletemotel	Command to delete motel, editable in config.lua.
/save-motel	Save data command, editable in config.lua.
/shareMotelKey [id]	Room sharing command, editable in config.lua.
/raid	Start police raid, editable in config.lua.

---

Client Exports

This section provides all available client exports for the script. These functions allow you to interact directly with the system from the client side, enabling custom features, UI interactions, and integrations with other resources. Each export includes a short description and usage example for easy implementation.

getCurrentRoom

The getCurrentRoom export allows you to retrieve the identifier of the room the player is currently in. This is useful for tracking player location within the motel system or implementing room-specific logic.

---

How to Use

To get the current room of a player, use the following code:

local currentRoom = exports['qs-motels-creator']:getCurrentRoom()
if currentRoom then
    print("The player is currently in room: " .. currentRoom)
else
    print("The player is not in any room.")
end

This example retrieves the room identifier and checks if the player is inside a room. Use this export to integrate room data into your scripts seamlessly.

---

Server Exports

This section provides all available server exports for the script. These functions allow developers to interact with the system from the server side, manage data, trigger actions, and integrate with other resources. Each export includes a clear description and a practical example to simplify its implementation.

kickCustomer

The kickCustomer export allows you to remove a player from their assigned motel room by specifying their unique identifier. This can be used for administrative purposes or to manage motel room availability.

---

How to Use

To kick a player from their motel room, use the following code:

local playerIdentifier = "steam:110000123456789" -- Replace with the player's identifier
exports['qs-motels-creator']:kickCustomer(playerIdentifier)
print("Player with identifier " .. playerIdentifier .. " has been removed from their motel room.")

This example will remove the specified player from their assigned motel, update the server-side data, and notify them in-game. Use this export to manage motel rooms effectively in your scripts.