This site has been archived and made available for preservation purposes. No edits can be made.

UIMessage

(Difference between revisions)
Return to current revision
  1.  
    Displays a Fallout UI message to a [wiki]Player[/wiki].[image]UIMessage.jpg|thumb|right|UIMessage in-game[/image]
    [h="2"] Declaration [/h]
    [highlight=cpp]
    VAULTSCRIPT vaultmp::State (*UIMessage)(vaultmp::ID, vaultmp::String);
    native Bool:UIMessage(ID, const message{});
    [/highlight]
    [h="2"] Parameters [/h]
  2. -
    [b][wiki="ID"]vaultmp::ID[/wiki][/b] - the ID of the [wiki]Player[/wiki]. If zero, will be sent to all connected players.
  3. +
    [b][wiki="ID"]vaultmp::ID[/wiki][/b] - the ID of the [wiki]Player[/wiki]. If zero, will be sent to all connected players
  4.  
    [b][wiki="String"]vaultmp::String[/wiki][/b] - the message to display, with a maximum length of [wiki]MAX_MESSAGE_LENGTH[/wiki] characters
    [h="2"] Return value [/h]
    Returns a [wiki="State"]vaultmp::State[/wiki] indicating the success.
    [h="2"] Related pages [/h]
    [list][*][wiki]MAX_MESSAGE_LENGTH[/wiki]
    [/LIST]
    [category]VaultMP interface[/category]
    [category]Scripting functions[/category]
    [category]Game functions[/category]