General Exports
This page explains the available exports for the r_pepperspray script and how to use them. These client-side exports allow you to interact programmatically with the pepper spray system from other resources.
1. Exports Overview
1.1 SetGassedPlayer
exports['r_pepperspray']:SetGassedPlayer(weaponName)
Description: Applies the gas effect to the player based on the specified command (e.g., pepper spray).
Parameters:
weaponName
: The command identifying the type of gas effect to apply (e.g., pepper spray).
1.2 RemoveGas
exports['r_pepperspray']:RemoveGas()
Description: Removes the gas effect from the player.
1.3 SetPepperQuantity
exports['r_pepperspray']:SetPepperQuantity(quantity)
Description: Sets the amount of spray available to the player (either pepper spray or decontamination spray).
Parameters:
quantity
(number): The amount of spray to set for the player.
1.4 IsGassed
exports['r_pepperspray']:IsGassed()
Description: Returns whether the player is currently gassed or not.
Returns:
true
: If the player is gassed.false
: If the player is not gassed.
2. Example Usage
Hereโs a basic example of how to use the pepper spray exports:
-- Apply the pepper spray effect to the player
exports['r_pepperspray']:SetGassedPlayer('pepper_spray')
-- Remove the gas effect from the player
exports['r_pepperspray']:RemoveGas()
-- Set the pepper spray quantity for the player to 5
exports['r_pepperspray']:SetPepperQuantity(5)
-- Check if the player is gassed
local isGassed = exports['r_pepperspray']:IsGassed()
if isGassed then
print("Player is gassed!")
else
print("Player is not gassed.")
end
Last updated