Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

Difference between revisions of "UE2:ACTION DisplayMessage (U2)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
(almost same as UT2004 version)
 
Line 1: Line 1:
{{infobox class
+
{{UE2:ACTION_DisplayMessage (UT2004)}}
| package = Legend
+
| parent1 = ScriptedAction
+
| parent2 = Object
+
}}
+
{{autogenerated}}
+
null
+
 
+
==Properties==
+
===Property group 'Action'===
+
====bBroadcast====
+
'''Type:''' [[bool]]
+
 
+
<!-- enter variable description -->
+
 
+
====Message====
+
'''Type:''' [[string]]
+
 
+
<!-- enter variable description -->
+
 
+
====MessageType====
+
'''Type:''' [[name]]
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' 'CriticalEvent'
+
 
+
===Default values===
+
{| class="list defaults"
+
! Property
+
! Value
+
|-
+
| {{tl|ActionString||ScriptedAction}}
+
| "display message"
+
|}
+
 
+
==Instance functions==
+
====GetActionString====
+
{{code|function [[string]]&nbsp;'''GetActionString''' ()}}
+
 
+
'''Overrides:''' {{tl|GetActionString|ScriptedAction}}
+
 
+
<!-- enter function description -->
+
 
+
====InitActionFor====
+
{{code|function [[bool]]&nbsp;'''InitActionFor''' ({{cl|ScriptedController}}&nbsp;'''C''')}}
+
 
+
'''Overrides:''' {{tl|InitActionFor|ScriptedAction}}
+
 
+
<!-- enter function description -->
+

Latest revision as of 03:02, 17 November 2009

U2 Object >> ScriptedAction >> ACTION_DisplayMessage
Package: 
Legend
This class in other games:
UE2Runtime, UT2003, UT2004

Displays a HUD message.

Properties[edit]

Property group 'Action'[edit]

bBroadcast[edit]

Type: bool

Whether to broadcast the message to all players. Otherwise the message is only sent to the instigator.

Message[edit]

Type: string

The message string to display.

MessageType[edit]

Type: name

The message type to use. The default value 'CriticalEvent' causes a large HUD message to be displayed. Most other values result in a console message in the chat area instead.

Default value: 'CriticalEvent'

Default values[edit]

Property Value
ActionString "display message"

Instance functions[edit]

GetActionString[edit]

function string GetActionString ()

Overrides: ScriptedAction.GetActionString

Returns the Description "display message" plus the messge string.

InitActionFor[edit]

function bool InitActionFor (ScriptedController C)

Overrides: ScriptedAction.InitActionFor

Sends the message.