DisplayHelpText

From GT-MP
Jump to: navigation, search
DisplayHelpText
Client-Side Function
System-users.png Client-Side Javascript.png JavaScript

Displays a helptext on the top left of the screen.

Dialog-warning.png Note: This feature is currently not in the API, or is currently not accurate on the wiki due to upcoming API changes. New API functions and changes will be released with the next update.

Syntax

In Javascript
Client-Side Function

API.displayHelpText(string text, int time, int color = -1, int alpha = 200);

Required Arguments

  • text parameter input should be in string type.
  • time parameter input should be in int type.

Optional Arguments

  • color parameter input should be in int type. See HudColorList.
  • alpha parameter input should be in int type. (Only works if color is greater or equal to 0)

Usage example

In Javascript
Client-Side Function

API.displayHelpText(string text, int time, int color = -1, int alpha = 200);

NormalHelpText.png

ColoredHelpText.png

References