AddUiMessageΒΆ

Creates a new ui message in the top left corner of the screen. Suitable for one-off messages, not suitable for constantly changing information.

Arguments:

Info (String)
The message to be displayed.
DisplayTime (float) optional
The amount of time in seconds to display the message for. Default value is 3.0 if not specified.
UseSecondaryAnim (bool) optional
Whether or not to animate the background of the message. Default is false if not specified.
ForceRedisplay (bool) optional
Unknown purpose. Default is false if not specified.

Returns:

  • None

Examples:

--Call it with no optional arguments
rfg.AddUiMessage("Player position: " .. Player.Position:ToString())
--Call it with the DisplayTime optional arg
rfg.AddUiMessage("Player position: " .. Player.Position:ToString(), 8.0)
--Call it with the UseSecondaryAnim optional arg to animate the message
rfg.AddUiMessage("Player position: " .. Player.Position:ToString(), 8.0, true)