This site has been archived and made available for preservation purposes. No edits can be made.
UIMessage
(Difference between revisions)
Return to current revision
-
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);
-
+
VAULTSCRIPT VAULTSPACE State (*VAULTAPI(UIMessage))(VAULTSPACE ID, VAULTSPACE cRawString) VAULTCPP(noexcept);
[/highlight]
[highlight=c]
-
native Bool:UIMessage(ID, const message{});
[/highlight]
[h="2"] Parameters [/h]
-
-
[b][wiki="ID"]vaultmp::ID[/wiki][/b] - the ID of the [wiki]Player[/wiki]. If zero, will be sent to all connected players
[b][wiki="String"]vaultmp::String[/wiki][/b] - the message to display, with a maximum length of [wiki]MAX_MESSAGE_LENGTH[/wiki] characters
-
+
[b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Player[/wiki]. If zero, will be sent to all connected players
[b][wiki="cRawString"]cRawString[/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.
-
+
Returns a [wiki="State"]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]