Difference between revisions of "Message Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
m (Languages Bar Added)
 
(2 intermediate revisions by one other user not shown)
Line 16: Line 16:


== Global Functions ==
== Global Functions ==
'''Function [[ResetHelpMessage - Message|ResetHelpMessage]](string asEvent)'''
 
*Resets the status of a help message input event, allowing a message to be displayed for that input event
:'''[[ResetHelpMessage - Message|ResetHelpMessage]](String ''asEvent'')'''
:*Resets the status of a help message input event, allowing a message to be displayed for that input event
 


== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''Int [[Show - Message|Show]](Float ''afArg1'', Float ''afArg2'', Float ''afArg3'', Float ''afArg4'', Float ''afArg5'', Float ''afArg6'', Float ''afArg7'', Float ''afArg8'', Float ''afArg9'')'''
!style="text-align:left;"|Function
:*Shows this message on the screen, substituting in the appropriate numbers. If it's a message box, it waits til the user closes it and '''''returns the button they hit'''''.
!style="text-align:left;"|Description
|-
|[[Show - Message|Int '''Show'''(Float ''afArg1'', Float ''afArg2'', Float ''afArg3'', Float ''afArg4'', Float ''afArg5'', Float ''afArg6'', Float ''afArg7'', Float ''afArg8'', Float ''afArg9'')]]
|Shows this message on the screen, substituting in the appropriate numbers. If it's a message box, it waits til the user closes it and '''''returns the button they hit'''''.
|-


|[[ShowAsHelpMessage - Message|'''ShowAsHelpMessage'''(String ''asEvent'', Float ''afDuration'', Float ''afInterval'', Int ''aiMaxTimes'')]]
:'''[[ShowAsHelpMessage - Message|ShowAsHelpMessage]](String ''asEvent'', Float ''afDuration'', Float ''afInterval'', Int ''aiMaxTimes'')'''
|Shows help message for a user action on screen.
:*Shows help message for a user action on screen.
|-


|}


== Events ==
== Events ==
Line 44: Line 39:
* [[Message]]
* [[Message]]
* [[Text Replacement]]
* [[Text Replacement]]
{{Languages|Message Script}}

Latest revision as of 10:48, 11 November 2024


Extends: Form Script

Script for the manipulation of Message base objects.

Definition[edit | edit source]

ScriptName Message extends Form

Properties[edit | edit source]

None

Global Functions[edit | edit source]

ResetHelpMessage(String asEvent)
  • Resets the status of a help message input event, allowing a message to be displayed for that input event


Member Functions[edit | edit source]

Int Show(Float afArg1, Float afArg2, Float afArg3, Float afArg4, Float afArg5, Float afArg6, Float afArg7, Float afArg8, Float afArg9)
  • Shows this message on the screen, substituting in the appropriate numbers. If it's a message box, it waits til the user closes it and returns the button they hit.
ShowAsHelpMessage(String asEvent, Float afDuration, Float afInterval, Int aiMaxTimes)
  • Shows help message for a user action on screen.


Events[edit | edit source]

None

Notes[edit | edit source]

  • Message boxes have a 1023 character limit, any longer and Skyrim will crash to desktop when attempting to display the message. This limit is based on the number of characters entered into the editor, including numerical formatting characters and quest text substitution tags.

See Also[edit | edit source]


Language: English  • українська