| Home Page | Recent Changes | Preferences

# LocalMessage (UT)

UT :: Actor (UT) >> Info (UT) >> LocalMessage (Package: Engine)

A LocalMessage contains information about messages displayed on the HUD (UT). All LocalMessages used in UT and most mods are subclasses of LocalMessagePlus.

See LocalMessage for the UT2k3 version of this class.

## Properties

bool bComplexString
  Indicates a multicolor string message class.
bool bIsSpecial
  If true, don't add to normal queue.
bool bIsUnique
  If true and special, only one can be in the HUD queue at a time.
bool bIsConsoleMessage
  If true, put a GetString on the console.
bool bFadeMessage
  If true, use fade out effect on message.
bool bBeep
  If true, beep!
bool bOffsetYPos
  If the YPos indicated isn't where the message appears.
int Lifetime
  Number of seconds to stay in HUD message queue.
class<LocalMessage> ChildMessage
  In some cases, we need to refer to a child message.
bool bFromBottom
  Subtract YPos.
color DrawColor
  Color to display message with.
float XPos, YPos
  Coordinates to print message at.
bool bCenter
  Whether or not to center the message.

## Methods

All LocalMessage functions are static.

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)
  The message takes care of drawing itself from here.
string GetString (optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)
  Returns the string to display on the HUD.
string AssembleString (HUD (UT) myHUD, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional String MessageString)
  If the message is a string message this function returns the string to display.
ClientReceive (PlayerPawn P, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)
  Adds the message to the HUD's message queue.
color GetColor (optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2)
  Returns the color to draw this message in.
float GetOffset (int Switch, float YL, float ClipY)
  Returns the vertical position of the message based on the available height.
int GetFontSize (int Switch)
  Returns the font size of the message.

## Known Subclasses

- LocalMessagePlus

The Unreal Engine Documentation Site

Wiki Community

Topic Categories

Image Uploads

Random Page

Recent Changes

Offline Wiki

Unreal Engine

Console Commands

Terminology

Mapping Topics

Mapping Lessons

UnrealEd Interface

Questions&Answers

Scripting Topics

Scripting Lessons

Making Mods

Class Tree

Questions&Answers

Modeling Topics

Questions&Answers

Log In