Exports
- Added
- Updated
Server side
registerGasZone
Register dynamic toxic gas zones with server-wide unique keys.
| Argument | Type | Description |
|---|---|---|
zones | table<string, REC_BetterMask.Server.Exports.RegisterGasZone.Param> | Settings by key, including coords and radius |
Returns boolean.
exports.REC_BetterMask:registerGasZone(zones)
unregisterGasZone
Remove registered gas zones.
| Argument | Type | Description |
|---|---|---|
zoneKey | string|string[] | Key or keys to remove |
Returns boolean.
exports.REC_BetterMask:unregisterGasZone(zoneKey)
isProtected
Check whether a player is wearing a mask with remaining filter capacity.
| Argument | Type | Description |
|---|---|---|
playerId | integer | Player server ID |
Returns boolean.
exports.REC_BetterMask:isProtected(playerId)
useGasMask
ox_inventory server item callback for equipping or removing a gas mask.
| Argument | Type |
|---|---|
event | "usingItem" | "usedItem" | "buying" |
item | table |
inventory | table |
slot | integer |
exports.REC_BetterMask:useGasMask(event, item, inventory, slot)
This function is called by ox_inventory. Set it as the item’s server.export with consume = 0.
useOxygenMask
ox_inventory server item callback for equipping or removing an oxygen mask.
| Argument | Type |
|---|---|
event | "usingItem" | "usedItem" | "buying" |
item | table |
inventory | table |
slot | integer |
exports.REC_BetterMask:useOxygenMask(event, item, inventory, slot)
This function is called by ox_inventory. Set it as the item’s server.export with consume = 0.
getGasZones
Returns the registered gas zones keyed by zone ID.
Takes no arguments.
Returns: table<string, REC_BetterMask.Shared.GasZone>.
exports.REC_BetterMask:getGasZones()
isWearingMask
Checks whether a mask is worn; pass a mask type to restrict the check.
| Argument | Type |
|---|---|
playerId | integer |
maskType? | REC_BetterMask.Shared.Enum.MaskType |
Returns: boolean.
exports.REC_BetterMask:isWearingMask(playerId, maskType)
hasOxygen
Checks whether the worn oxygen mask has oxygen remaining.
| Argument | Type |
|---|---|
playerId | integer |
Returns: boolean.
exports.REC_BetterMask:hasOxygen(playerId)
isPlayerInGas
Checks whether the player is inside a gas zone.
| Argument | Type |
|---|---|
playerId | integer |
Returns: boolean.
exports.REC_BetterMask:isPlayerInGas(playerId)
getMaskState
Returns the mask state, including its type and remaining charge.
| Argument | Type |
|---|---|
playerId | integer |
Returns: REC_BetterMask.Shared.MaskState|nil.
exports.REC_BetterMask:getMaskState(playerId)
Client side
isWearingMask
Checks whether a mask is worn; pass a mask type to restrict the check.
| Argument | Type |
|---|---|
maskType? | REC_BetterMask.Shared.Enum.MaskType |
Returns: boolean.
exports.REC_BetterMask:isWearingMask(maskType)
isProtected
Checks whether a gas mask with remaining charge protects the player.
Takes no arguments.
Returns: boolean.
exports.REC_BetterMask:isProtected()
hasOxygen
Checks whether the worn oxygen mask has oxygen remaining.
Takes no arguments.
Returns: boolean.
exports.REC_BetterMask:hasOxygen()
isInGas
Checks whether the local player is inside a gas zone.
Takes no arguments.
Returns: boolean.
exports.REC_BetterMask:isInGas()
getMaskState
Returns the mask state, including its type and remaining charge.
Takes no arguments.
Returns: REC_BetterMask.Shared.MaskState.
exports.REC_BetterMask:getMaskState()
MaskState
| Field | Type | Description |
|---|---|---|
isWearing | boolean | Mask equipped |
type | "gas"|"oxygen"|nil | Equipped mask type |
durability | number | Remaining charge (0–100) |
isInGas | boolean | Inside a gas zone |
isUnderwater | boolean | Underwater state |