Module f3x-wrapper-extended-admin-house
Extended version of f3x-wrapper for the game ‘Admin House!’ by Kaderth
See also:
Info:
- Copyright: bqmb3 2024
- License: MIT
- Author: bqmb3
Functions
| F3X:GetBuilds () | Gets the list of builds. |
| F3X:HasBuild (buildName) | Checks if a build exists. |
| F3X:LoadBuild (buildName) | Loads a build. |
| F3X:SetLockMode (mode) | Sets the lock mode. |
| F3X:SetLockModeToEveryone () | Sets the lock mode to everyone. |
| F3X:SetLockModeToFriends () | Sets the lock mode to friends. |
| F3X:SetLockModeToCustom () | Sets the lock mode to custom. |
| F3X:SetLockModeToOnlyMe () | Sets the lock mode to only me. |
| F3X:GetWhitelistedPlayers () | Gets the list of whitelisted players. |
| F3X:AddToWhitelist (userId) | Adds a player to the whitelist. |
| F3X:RemoveFromWhitelist (userId) | Removes a player from the whitelist. |
Functions
- F3X:GetBuilds ()
-
Gets the list of builds.
Returns:
-
table
List of build names
- F3X:HasBuild (buildName)
-
Checks if a build exists.
Parameters:
- buildName string Name of the build
Returns:
-
boolean
True if the build exists, false otherwise
- F3X:LoadBuild (buildName)
-
Loads a build.
Parameters:
- buildName string Name of the build
Returns:
-
table
List of instances in the build
- F3X:SetLockMode (mode)
-
Sets the lock mode.
Parameters:
- mode number Lock mode
- F3X:SetLockModeToEveryone ()
-
Sets the lock mode to everyone.
Returns:
-
nil
- F3X:SetLockModeToFriends ()
-
Sets the lock mode to friends.
Returns:
-
nil
- F3X:SetLockModeToCustom ()
-
Sets the lock mode to custom.
Returns:
-
nil
- F3X:SetLockModeToOnlyMe ()
-
Sets the lock mode to only me.
Returns:
-
nil
- F3X:GetWhitelistedPlayers ()
-
Gets the list of whitelisted players.
Returns:
-
table
List of whitelisted players
- F3X:AddToWhitelist (userId)
-
Adds a player to the whitelist.
Parameters:
- userId number User ID of the player
Returns:
-
nil
- F3X:RemoveFromWhitelist (userId)
-
Removes a player from the whitelist.
Parameters:
- userId number User ID of the player
Returns:
-
nil