- Found in:
- Workshop Framework
Description
Documentation Comment
Version: Added 1.0.8
Send messages through these to allow the player's setting to dictate whether or not they are displayed at the given moment. This allows the player to queue pop-ups and notifications for non-time sensitive things during combat, dialogue, etc. The player's settings will then determine if the queue is auto played, or if they have to access it manually via holotape (or some other interface)
Parameters:
Message aMessageToShow - The Message form.
Float afArg1 [... afArg9] - [Optional] Floats to be replaced in the message, this is the same as the vanilla Show function for Messages
ReferenceAlias aRefAlias - [Optional; Requires akObjectToAlias] If you are using text replacement, this would be the quest alias you need an object placed in. (You can read more about text replacement here: ObjectReference.AddTextReplacementData(...))
ObjectReference akObjectToAlias - [Optional] The object reference to fill into aRefAlias
LocationAlias aLocAlias - [Optional; Requires akLocationToAlias] If you are using text replacement, this would be the quest alias you need a location placed in. (You can read more about text replacement here: ObjectReference.AddTextReplacementData(...))
Location akLocationToAlias - [Optional] The location to fill into aLocAlias
Bool abAutoClearAliases - If true, the filled aliases will be cleared after the message is sent. (Note: The aliases are filled immediately before sending the message based on the parameters sent - while the message is in queue, the aliases aren't touched)
Returns:
True if the message was sent immediately, false if the message was queued up
TODO: Add support for the quest objectives as well
Parameters
MessageaMessageToShow
floatafArg1=0.0
floatafArg2=0.0
floatafArg3=0.0
floatafArg4=0.0
floatafArg5=0.0
floatafArg6=0.0
floatafArg7=0.0
floatafArg8=0.0
floatafArg9=0.0
ReferenceAliasaRefAlias=NONE
ObjectReferenceakObjectToAlias=NONE
LocationAliasaLocAlias=NONE
LocationakLocationToAlias=NONE
boolabAutoClearAliases=true
Examples
Auto-Generated Example
Message myMessage__aMessageToShow
float myFloat__afArg1
float myFloat__afArg2
float myFloat__afArg3
float myFloat__afArg4
float myFloat__afArg5
float myFloat__afArg6
float myFloat__afArg7
float myFloat__afArg8
float myFloat__afArg9
ReferenceAlias myReferenceAlias__aRefAlias
ObjectReference myObjectReference__akObjectToAlias
LocationAlias myLocationAlias__aLocAlias
Location myLocation__akLocationToAlias
bool myBool__abAutoClearAliases
bool returnedValue = WorkshopFramework:WSFW_API.ShowMessage(myMessage__aMessageToShow, myFloat__afArg1, myFloat__afArg2, myFloat__afArg3, myFloat__afArg4, myFloat__afArg5, myFloat__afArg6, myFloat__afArg7, myFloat__afArg8, myFloat__afArg9, myReferenceAlias__aRefAlias, myObjectReference__akObjectToAlias, myLocationAlias__aLocAlias, myLocation__akLocationToAlias, myBool__abAutoClearAliases)