UE2:ACTION DisplayMessage (UT2003): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
Auto-generated page
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{infobox class
{{UE2:ACTION_DisplayMessage (UT2004)}}
| package = Gameplay
| 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 02:56, 17 November 2009

UT2003 Object >> ScriptedAction >> ACTION_DisplayMessage
Package:
Gameplay
This class in other games:

Displays a HUD message.

Properties

Property group 'Action'

bBroadcast

Type: bool

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

Message

Type: string

The message string to display.

MessageType

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

Property Value
ActionString "display message"

Instance functions

GetActionString

function string GetActionString ()

Overrides: ScriptedAction.GetActionString

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

InitActionFor

function bool InitActionFor (ScriptedController C)

Overrides: ScriptedAction.InitActionFor

Sends the message.