Skip to main content

UI Component

Component Available
ServerYes
ClientYes

This is a general component for the user interface.

Methods


Server​

Balance (Prefix: Balance)​

UpdateCash​

  • Parameters: cash: number
  • Return: None
  • Description: Update UI cash

Client​

SendUIMessage​

  • Parameters: action: string, data: any
  • Return: None
  • Description: Sends a UI message

SetFocus​

  • Parameters: shouldFocus: boolean
  • Return: None
  • Description: Set the UI focus whether or not should focus

Hud (Prefix: Hud)​

Show​

  • Parameters: None
  • Return: None
  • Description: Show the hud

Hide​

  • Parameters: None
  • Return: None
  • Description: Hide the hud

Update​

  • Parameters: data: table
  • Return: None
  • Description: Update the hud status

Reset​

  • Parameters: shouldFocus: boolean
  • Return: None
  • Description: Reset the hud status

Vehicle (Prefix: Vehicle)​

Show​

  • Parameters: None
  • Return: None
  • Description: Show the vehicle hud

Hide​

  • Parameters: None
  • Return: None
  • Description: Hide the vehicle hud

Update​

  • Parameters: data: table
  • Return: None
  • Description: Update the vehicle hud status

Balance (Prefix: Balance)​

ShowBank​

  • Parameters: None
  • Return: None
  • Description: Show bank cash

ShowCash​

  • Parameters: None
  • Return: None
  • Description: Show cash

UpdateCash​

  • Parameters: cash: number
  • Return: None
  • Description: Update cash

UpdateBank​

  • Parameters: cash: number
  • Return: None
  • Description: Update bank cash

Voip (Prefix: Voip)​

ToggleTalking​

  • Parameters: None
  • Return: None
  • Description: Toggle talking in the hud

ToggleRadio​

  • Parameters: None
  • Return: None
  • Description: Toggle radio in the hud

Action (Prefix: Action)​

Show​

  • Parameters: actionText: string, color: "success" | "error" | "default"
  • Return: None
  • Description: Show action

Hide​

  • Parameters: None
  • Return: None
  • Description: Hide action

Events​


Server​

No server events are fired from this component.

Client​

No client events are fired from this component.