Module script.helpers.c_functions
Client extension module for Advanced Roleplay Environment.
Functions
| ShowNotification (text) | Shows a notification |
| GetClosestPlayer () | Gets the closest player |
| RunAnimation (animation, duration, blockActions) | Runs an animation |
| CreateProgressBar (text, duration, xFactorParam) | Creates a progress bar |
| DestroyProgressBar (data) | Destroys a progress bar |
| IsProgressBarActive () | Returns true if a progress bar is active |
| CarryPlayer (targetData, targetHealthBuffer) | Carrys a player |
| StopCarry () | Stop active carry |
| PlayLocalAnimationLoop () | Plays the local animation loop |
| EmergencyDispatch (playerPed, coords) | Emergency dispatch to configured receiver |
| LoadPlayer () | Loads the player |
| SpawnGameObject (name, x, y, z) | Spawns a game object |
| CleanUpGameObjects () | Cleans up spawned game objects |
| OpenSelfMenu () | Function for the self menu command |
| OpenInteractionMenu () | Function for the interaction menu command |
| ManualRespawn () | Function for the manual respawn command |
| CancelInteraction () | Function for the cancel interaction command |
| IsPlayerDamageDisabled () | Returns if the player damage is disabled |
Functions
- ShowNotification (text)
-
Shows a notification
Parameters:
- text any
- GetClosestPlayer ()
-
Gets the closest player
Returns:
- integer
- number
- RunAnimation (animation, duration, blockActions)
-
Runs an animation
Parameters:
- animation any
- duration any
- blockActions any
- CreateProgressBar (text, duration, xFactorParam)
-
Creates a progress bar
Parameters:
- text any
- duration any
- xFactorParam any
- DestroyProgressBar (data)
-
Destroys a progress bar
Parameters:
- data any
- IsProgressBarActive ()
-
Returns true if a progress bar is active
Returns:
-
boolean
- CarryPlayer (targetData, targetHealthBuffer)
-
Carrys a player
Parameters:
- targetData any
- targetHealthBuffer any
- StopCarry ()
- Stop active carry
- PlayLocalAnimationLoop ()
- Plays the local animation loop
- EmergencyDispatch (playerPed, coords)
-
Emergency dispatch to configured receiver
Parameters:
- playerPed any
- coords any
- LoadPlayer ()
- Loads the player
- SpawnGameObject (name, x, y, z)
-
Spawns a game object
Parameters:
- name any
- x any
- y any
- z any
Returns:
-
any
- CleanUpGameObjects ()
- Cleans up spawned game objects
- OpenSelfMenu ()
- Function for the self menu command
- OpenInteractionMenu ()
- Function for the interaction menu command
- ManualRespawn ()
- Function for the manual respawn command
- CancelInteraction ()
- Function for the cancel interaction command
- IsPlayerDamageDisabled ()
-
Returns if the player damage is disabled
Returns:
-
boolean