Module script.helpers.s_functions
Server extension module for Advanced Roleplay Environment.
Functions
| HasItem (source, item, amount) | Returns true if the player has the item with the specified amount |
| AddItem (source, item, amount) | Adds an item to the player |
| RemoveItem (source, item, amount) | Removes an item from the player |
| GetItems (source) | Gets all items from the player |
| IsAllowedToPerformAction (source, category, action) | Returns true if the player is allowed to perform a action |
| IsAllowedToOpenMenu (source) | Returns true if the player is allowed to open the menu |
| SavePlayer (source) | Saves the player |
| LoadPlayer (source) | Loads the player |
| GetPlayerMenuTitleName (source) | Gets the menu title name from the player |
| GetPlayerJob (source) | Gets the player job |
| GetPlayerCustomIdentifier (source) | Gets the player identifier (framework related) |
| ShouldIgnoreItems (source) | Returns true if the player should return item amounts |
| GetMedicsOnDutyCount () | Gets the medics on duty |
| IsAllowedToUseTriageSystem (source) | Returns true if the player is allowed to use the triage system |
| GetAvailableItems () | Gets all available items configured in the actions.lua |
| SendDiscordLog (message, description) | Sends a discord log to the discord api |
Functions
- HasItem (source, item, amount)
-
Returns true if the player has the item with the specified amount
Parameters:
- source any
- item any
- amount any
Returns:
-
boolean
- AddItem (source, item, amount)
-
Adds an item to the player
Parameters:
- source any
- item any
- amount any
Returns:
-
boolean
- RemoveItem (source, item, amount)
-
Removes an item from the player
Parameters:
- source any
- item any
- amount any
- GetItems (source)
-
Gets all items from the player
Parameters:
- source any
Returns:
-
table
- IsAllowedToPerformAction (source, category, action)
-
Returns true if the player is allowed to perform a action
Parameters:
- source any
- category any
- action any
Returns:
-
boolean
- IsAllowedToOpenMenu (source)
-
Returns true if the player is allowed to open the menu
Parameters:
- source any
Returns:
-
boolean
- SavePlayer (source)
-
Saves the player
Parameters:
- source any
- LoadPlayer (source)
-
Loads the player
Parameters:
- source any
- GetPlayerMenuTitleName (source)
-
Gets the menu title name from the player
Parameters:
- source any
Returns:
-
unknown
- GetPlayerJob (source)
-
Gets the player job
Parameters:
- source any
Returns:
-
unknown
- GetPlayerCustomIdentifier (source)
-
Gets the player identifier (framework related)
Parameters:
- source any
Returns:
-
any
- ShouldIgnoreItems (source)
-
Returns true if the player should return item amounts
Parameters:
- source any
Returns:
-
boolean
- GetMedicsOnDutyCount ()
-
Gets the medics on duty
Returns:
-
integer
- IsAllowedToUseTriageSystem (source)
-
Returns true if the player is allowed to use the triage system
Parameters:
- source any
Returns:
-
boolean
- GetAvailableItems ()
-
Gets all available items configured in the actions.lua
Returns:
-
table
- SendDiscordLog (message, description)
-
Sends a discord log to the discord api
Parameters:
- message any
- description any