UE1:LocalMessage (UT)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 09:10, 17 May 2008 by Wormbo (talk | contribs) (Auto-generated page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
UT Object >> Actor >> Info >> LocalMessage
Package:
Engine
Direct subclass:
LocalMessagePlus
This class in other games:

Represents a schematic for a client localized message.

Properties

bBeep

Type: bool

If true, beep!

bCenter

Type: bool

Whether or not to center the message.

bComplexString

Type: bool

Indicates a multicolor string message class.

bFadeMessage

Type: bool

If true, use fade out effect on message.

bFromBottom

Type: bool

Subtract YPos.

bIsConsoleMessage

Type: bool

If true, put a GetString on the console.

bIsSpecial

Type: bool

If true, don't add to normal queue.

bIsUnique

Type: bool

If true and special, only one can be in the HUD queue at a time.

bOffsetYPos

Type: bool

If the YPos indicated isn't where the message appears.

ChildMessage

Type: class<LocalMessage>


DrawColor

Type: Object.Color

Color to display message with.

Default value:

Member Value
B 255
G 255
R 255

Lifetime

Type: int

  1. of seconds to stay in HUD message queue.

Default value: 3

XPos

Type: float


YPos

Type: float

Coordinates to print message at.

Static functions

AssembleString

static function string AssembleString (HUD myHUD, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional string MessageString)


ClientReceive

static function ClientReceive (PlayerPawn P, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)


GetColor

static function Object.Color GetColor (optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2)


GetFontSize

static function int GetFontSize (int Switch)


GetOffset

static function float GetOffset (int Switch, float YL, float ClipY)


GetString

static function string GetString (optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)


RenderComplexMessage

static function RenderComplexMessage (Canvas Canvas, out float XL, out float YL, optional string MessageString, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)