Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

GameFramework.SeqEvent_HudRenderText

Extends
SeqEvent_HudRender

Copyright 1998-2011 Epic Games, Inc. All Rights Reserved. This is the base class of all Mobile sequence events.

Core.Object
|   
+-- Engine.SequenceObject
   |   
   +-- Engine.SequenceOp
      |   
      +-- Engine.SequenceEvent
         |   
         +-- GameFramework.SeqEvent_HudRender
            |   
            +-- GameFramework.SeqEvent_HudRenderText

Variables Summary
HUD
colorDisplayColor
fontDisplayFont
vectorDisplayLocation
stringDisplayText
ETextDrawMethodTextDrawMethod
Inherited Variables from GameFramework.SeqEvent_HudRender
AuthoredGlobalScale, bIsActive, Targets
Inherited Variables from Engine.SequenceEvent
ActivationTime, bClientSideOnly, bEnabled, bPlayerOnly, bRegistered, DuplicateEvts, Instigator, MaxTriggerCount, MaxWidth, Originator, Priority, ReTriggerDelay, TriggerCount

Enumerations Summary
ETextDrawMethod
DRAW_CenterText, DRAW_WrapText,

Functions Summary
eventint GetObjClassVersion ()))
function Render (Canvas TargetCanvas, Hud TargetHud))
Inherited Functions from GameFramework.SeqEvent_HudRender
RegisterEvent, Render
Inherited Functions from Engine.SequenceEvent
CheckActivate, RegisterEvent, Reset, Toggled


Variables Detail

HUD

DisplayColor Source code

var(HUD) color DisplayColor;
The Color to draw the text in

DisplayFont Source code

var(HUD) font DisplayFont;
The Font to draw

DisplayLocation Source code

var(HUD) vector DisplayLocation;
The Location to display the text at

DisplayText Source code

var(HUD) string DisplayText;
The text to draw. NOTE: You can set this via the variable link

TextDrawMethod Source code

var(HUD) ETextDrawMethod TextDrawMethod;
Whether the text should be centered at the display location


Enumerations Detail

ETextDrawMethod Source code

enum ETextDrawMethod
{
DRAW_CenterText, DRAW_WrapText,
};


Functions Detail

GetObjClassVersion Source code

static event int GetObjClassVersion ( ) )
Return the version number for this class. Child classes should increment this method by calling Super then adding a individual class version to the result. When a class is first created, the number should be 0; each time one of the link arrays is modified (VariableLinks, OutputLinks, InputLinks, etc.), the number that is added to the result of Super.GetObjClassVersion() should be incremented by 1.
@return the version number for this specific class.

Render Source code

function Render ( Canvas TargetCanvas, Hud TargetHud) )
Perform the actual rendering


Defaultproperties

defaultproperties
{
	ObjName="Draw Text"
	ObjCategory="HUD"

	DisplayColor=(R=255,G=255,B=255,A=255)
	VariableLinks(2)=(ExpectedType=class'SeqVar_Vector',LinkDesc="Display Location",PropertyName=DisplayLocation,MaxVars=1)
	VariableLinks(3)=(ExpectedType=class'SeqVar_String',LinkDesc="Display Text",PropertyName=DisplayText,MaxVars=1)

	TextDrawMethod=DRAW_WrapText
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:56.664 - Created with UnCodeX