ShowMidsizedMessage

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

Shows a midsized message to the player. Midsized messages are like shards but they take less space on 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

This function has 2 overloads.

API.showMidsizedMessage(string title, string message, int bgColor, bool useDarkerShard, int time = 5000);
API.showMidsizedMessage(string title, string message, int bgColor, bool useDarkerShard, bool condensed, int time = 5000);

Overload 1:

  • title parameter input should be in string type.
  • message parameter input should be in string type.
  • bgColor parameter input should be in int type. See HudColorList.
  • useDarkerShard parameter input should be in bool type.

Overload 2:

  • title parameter input should be in string type.
  • message parameter input should be in string type.
  • bgColor parameter input should be in int type. See HudColorList.
  • useDarkerShard parameter input should be in bool type.
  • condensed parameter input should be in bool type.

Optional:

  • time parameter input should be in int type.

Usage example

In Javascript
Client-Side Function

Normal midsized message:

API.showMidsizedMessage("Midsized Message", "This is a midsized message and it looks pretty!", 20, false);

MidsizedMessageExample.jpg

In Javascript
Client-Side Function

Condensed midsized message:

API.showMidsizedMessage("Midsized Message", "condensed = true", 11, false, true);

MidsizedMessageCondensed.png

References