Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

# TribesGUI.HUDElement

Extends
  Object
Modifiers
  native abstract PerObjectConfig config ( TribesHUD )

    Core.Object
    |
    +-- TribesGUI.HUDElement

#### Direct Known Subclasses:

> HUDContainer, HUDDamageIndicator, HUDIcon, HUDNumericTextureLabel, HUDTalkingHead, HUDUseableMarker, HUDVehicleManifest, LabelElement, QuickChatMenu

Constants Summary

Inherited Contants from Core.Object
MaxInt, Pi, RF_NotForClient, RF_NotForEdit, RF_NotForServer, RF_Public, RF_Transactional, RF_Transient, RF_Unnamed

Variables Summary
TribesHUDScript | BaseScript
bool | bFlashing
bool | bIsLayingOut
bool | bNeedsLayout
bool | bRenderedOnce
float | FlashAlphaMax
float | FlashAlphaMin
float | FlashDuration
float | FlashPeriod
float | FlashStartTime
float | FlashSwitchTime
Font | HelpFont
String | HelpFontName
String | HelpLabel
float | initialHeight
float | initialPosX
float | initialPosY
float | initialWidth
ClientSideCharacter | LocalData
HUDElement | nextSibling
HUDContainer | ParentElement
HUDElement | previousSibling
float | screenHeight
float | screenWidth
float | TargetAlpha
float | timeSeconds
HUDElement
float | alpha
float | aspectRatio
HUDMaterial | backgroundTexture
int | borderBottom
int | borderLeft
int | borderRight
int | borderTop
bool | bRelativePositioning
bool | bUseResFonts
bool | bVisible
Color | defaultDrawColor
HUDMaterial | foregroundTexture
float | Height
EHorizontalAlignment | horizontalAlignment
EHorizontalFill | horizontalFill
String | iniOverride
int | insetX
int | insetY
int | offsetX
int | offsetY
float | posX
float | posY
float | RelativeHeight
float | RelativePosX
float | RelativePosY
float | RelativeWidth
Array<String> | resFontNames
Array<Font> | resFonts
Color | textColor
Font | textFont
String | textFontName
EVerticalAlignment | verticalAlignment
EVerticalFill | verticalFill
float | Width

Inherited Variables from Core.Object
Class, Name, ObjectFlags, ObjectInternal[6], Outer

Enumerations Summary
EHorizontalAlignment HALIGN_None, HALIGN_Relative, HALIGN_Left, HALIGN_Center, HALIGN_Right, HALIGN_Previous, HALIGN_Next
EHorizontalFill HFILL_None, HFILL_Relative, HFILL_Left, HFILL_Right, HFILL_Both
ELayoutDirection LD_ManualLayout, LD_Horizontal, LD_Vertical
EVerticalAlignment VALIGN_None, VALIGN_Relative, VALIGN_Top, VALIGN_Middle, VALIGN_Bottom, VALIGN_Previous, VALIGN_Next
EVerticalFill VFILL_None, VFILL_Relative, VFILL_Up, VFILL_Down, VFILL_Both

Inherited Enumerations from Core.Object
EAxis, ECamOrientation, ESheerAxis

Structures Summary
HUDMaterial material, drawColor, coords, style, bStretched, bNoRender, bProgressControlled, bFlashing, flashFrequency, lastFlashTime, bFading, bFadePulse, fadeSourceColor, fadeTargetColor, fadeDuration, fadeStartTime, fadeProgress

Inherited Structures from Core.Object
BoundingVolume, Box, Color, CompressedPosition, Coords, GameSpyServerData, Guid, IntegerRange, InterpCurve, InterpCurvePoint, MatCoords, Matrix, Plane, Quat, Range, RangeVector, Rotator, Scale, Vector

Functions Summary
|  | Construct ()))
| HUDElement | CreateClonedElement (string className, string objectName, optional string newObjectName))
| HUDElement | CreateHUDElement (class<HUDElement> elementClass, String elementName, optional Object ownerObject))
|  | DoLayout (Canvas c))
| String | EncodeColor (Color InColor)
| String | EncodePlayerName (String PlayerName, String TeamTag, ETeamAlignment alignment, optional class<TeamInfo> PlayerTeam))
|  | FlashElement (float period, float duration, float AlphaMin, float AlphaMax))
|  | ForceNeedsLayout ()))
| float | GetAlpha ()))
| int | GetHeight ()))
| float | GetMaximumRelativeX ()))
| float | GetMaximumRelativeY ()))
| float | GetMaximumX ()))
| float | GetMaximumY ()))
|  | GetScreenPos (out int ScreenPosX, out int ScreenPosY))
| int | GetWidth ()))
| int | GetX ()))
| int | GetY ()))
|  | InitElement ()))
|  | InitElementHeirachy (TribesHUDScript base, HUDContainer Parent))
| int | InternalHeight ()))
| int | InternalLeft ()))
| int | InternalTop ()))
| int | InternalWidth ()))
| bool | KeyEvent (EInputKey Key, EInputAction Action, FLOAT Delta, HUDAction Response)
| bool | KeyType (EInputKey Key, string Unicode, HUDAction Response)
|  | Layout (Canvas canvas)
|  | LoadConfig (String objectConfigName, class objectClass, optional String Filename)
|  | LoadFont (String FontName, out Font font))
|  | LoadFonts ()))
| HUDMaterial | MakeHUDMaterial (Material mat))
| int | MaterialHeight (HUDMaterial mat))
| int | MaterialWidth (HUDMaterial mat))
|  | NativeRenderElement (Canvas c)
|  | OnMouseClicked (HUDElement Sender)
|  | OnMouseDoubleClicked (HUDElement Sender)
|  | OnMouseEntered (HUDElement Sender)
|  | OnMouseExited (HUDElement Sender)
| bool | PointInElement (int PointX, int PointY))
| bool | PointInRegion (int PointX, int PointY, int X1, int Y1, int X2, int Y2))
|  | Render (Canvas c)
|  | RenderElement (Canvas C))
|  | RenderHUDMaterial (Canvas c, out HUDMaterial mat, float matWidth, float matHeight, optional float tileSizeX, optional float tileSizeY)
|  | ResetFont ()))
|  | ResetHUDMaterial (out HUDMaterial mat))
|  | ResizeForWidth (Canvas c, int pixelWidth)
| TribesHUDScript | RootHUDScript ()))
|  | SetAlpha (float newAlpha))
|  | SetColor (Canvas C, Color newColor))
|  | SetHeight (int newHeight))
|  | SetNeedsLayout ()))
|  | SetWidth (int newWidth))
|  | SetX (int newX))
|  | SetY (int newY))
| HUDElement | StaticCreateHUDElement (class<HUDElement> elementClass, String elementName, optional Object ownerObject))
|  | UpdateData (ClientSideCharacter c)

Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, AllClasses, AllEditableProperties, Allocate, AllProperties, AppSeconds, Asc, Asin, AssertWithDescription, Atan, BeginState, CanSLog, Caps, Chr, Clamp, ClassConstruct, ClassIsChildOf, ClockwiseFrom, CommonBase, Construct, Cos, Cross, DecodeFromURL, Disable, Div, Dot, DynamicFindObject, DynamicLoadObject, Enable, EncodeForURL, EndState, Eval, Exp, FClamp, FindObject, FlushConfig, FMax, FMin, FRand, GetAxes, GetBuildNumber, GetEnum, GetMinCompatibleBuildNumber, GetPropertyText, GetStateName, GetSuperClass, GetUnAxes, GotoState, Hash, HasUnicode, InStr, InterpCurveEval, InterpCurveGetInputDomain, InterpCurveGetOutputRange, Inverse, Invert, IsA, IsInState, IsNearlyZero, IsUTracing, IsValidForURL, IsZero, Left, Len, Lerp, Localize, Locs, Log, Loge, LogGuardStack, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NullReferences, OrthoRotation, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatToRotator, Rand, RandRange, Repl, replaceStr, ResetConfig, Right, RotRand, SaveConfig, SetPropertyText, SetUTracing, Sin, Sleep, SLog, Smerp, Split, Sqrt, Square, StaticSaveConfig, StrCmp, Tan, VDist, VDistSquared, VRand, VSize, VSize2D, VSizeSquared, VSizeSquared2D, Warn, ^, ^^, |, ||, ~, ~=

Variables Detail

#### BaseScript Source code

var TribesHUDScript BaseScript;

#### bFlashing Source code

var bool bFlashing;

#### bIsLayingOut Source code

var bool bIsLayingOut;

#### bNeedsLayout Source code

var bool bNeedsLayout;

#### bRenderedOnce Source code

var bool bRenderedOnce;

#### FlashAlphaMax Source code

var float FlashAlphaMax;

#### FlashAlphaMin Source code

var float FlashAlphaMin;

#### FlashDuration Source code

var float FlashDuration;

#### FlashPeriod Source code

var float FlashPeriod;

#### FlashStartTime Source code

var float FlashStartTime;

#### FlashSwitchTime Source code

var float FlashSwitchTime;

#### HelpFont Source code

var Font HelpFont;

#### HelpFontName Source code

var String HelpFontName;

#### HelpLabel Source code

var String HelpLabel;

#### initialHeight Source code

var float initialHeight;

#### initialPosX Source code

var float initialPosX;

#### initialPosY Source code

var float initialPosY;

#### initialWidth Source code

var float initialWidth;

#### LocalData Source code

var ClientSideCharacter LocalData;

#### nextSibling Source code

var HUDElement nextSibling;

#### ParentElement Source code

var HUDContainer ParentElement;

#### previousSibling Source code

var HUDElement previousSibling;

#### screenHeight Source code

var float screenHeight;

#### screenWidth Source code

var float screenWidth;

#### TargetAlpha Source code

var float TargetAlpha;

#### timeSeconds Source code

var float timeSeconds;

### HUDElement

#### alpha Source code

var(HUDElement) config private float alpha;

#### aspectRatio Source code

var(HUDElement) config float aspectRatio;

#### backgroundTexture Source code

var(HUDElement) config HUDMaterial backgroundTexture;

> The background texture for the element

#### borderBottom Source code

var(HUDElement) config int borderBottom;

#### borderLeft Source code

var(HUDElement) config int borderLeft;

#### borderRight Source code

var(HUDElement) config int borderRight;

#### borderTop Source code

var(HUDElement) config int borderTop;

#### bRelativePositioning Source code

var(HUDElement) config bool bRelativePositioning;

#### bUseResFonts Source code

var(HUDElement) config bool bUseResFonts;

> Whether to use the resolution fonts

#### bVisible Source code

var(HUDElement) config bool bVisible;

#### defaultDrawColor Source code

var(HUDElement) config Color defaultDrawColor;

#### foregroundTexture Source code

var(HUDElement) config HUDMaterial foregroundTexture;

> The background texture for the element

#### Height Source code

var(HUDElement) config float Height;

#### horizontalAlignment Source code

var(HUDElement) config EHorizontalAlignment horizontalAlignment;

#### horizontalFill Source code

var(HUDElement) config EHorizontalFill horizontalFill;

#### iniOverride Source code

var(HUDElement) String iniOverride;

#### insetX Source code

var(HUDElement) config int insetX;

#### insetY Source code

var(HUDElement) config int insetY;

#### offsetX Source code

var(HUDElement) config int offsetX;

#### offsetY Source code

var(HUDElement) config int offsetY;

#### posX Source code

var(HUDElement) config float posX;

#### posY Source code

var(HUDElement) config float posY;

#### RelativeHeight Source code

var(HUDElement) config float RelativeHeight;

#### RelativePosX Source code

var(HUDElement) config float RelativePosX;

#### RelativePosY Source code

var(HUDElement) config float RelativePosY;

#### RelativeWidth Source code

var(HUDElement) config float RelativeWidth;

#### resFontNames Source code

var(HUDElement) config Array<String> resFontNames;

> Array of font names, representing the fonts for different resolutions

#### resFonts Source code

var(HUDElement) config Array<Font> resFonts;

> Array of fonts which will be used in differnet resolutions

#### textColor Source code

var(HUDElement) config Color textColor;

> Color to use for the text

#### textFont Source code

var(HUDElement) config Font textFont;

> Font to use for the text

#### textFontName Source code

var(HUDElement) config String textFontName;

> Name fo the Font to use for the text

#### verticalAlignment Source code

var(HUDElement) config EVerticalAlignment verticalAlignment;

#### verticalFill Source code

var(HUDElement) config EVerticalFill verticalFill;

#### Width Source code

var(HUDElement) config float Width;

Enumerations Detail

#### EHorizontalAlignment Source code

enum EHorizontalAlignment
{

> HALIGN_None, HALIGN_Relative, HALIGN_Left, HALIGN_Center, HALIGN_Right, HALIGN_Previous, HALIGN_Next

};

#### EHorizontalFill Source code

enum EHorizontalFill
{

> HFILL_None, HFILL_Relative, HFILL_Left, HFILL_Right, HFILL_Both

};

#### ELayoutDirection Source code

enum ELayoutDirection
{

> LD_ManualLayout, LD_Horizontal, LD_Vertical

};

#### EVerticalAlignment Source code

enum EVerticalAlignment
{

> VALIGN_None, VALIGN_Relative, VALIGN_Top, VALIGN_Middle, VALIGN_Bottom, VALIGN_Previous, VALIGN_Next

};

#### EVerticalFill Source code

enum EVerticalFill
{

> VFILL_None, VFILL_Relative, VFILL_Up, VFILL_Down, VFILL_Both

};

Structures Detail

#### HUDMaterial Source code

struct HUDMaterial
{

> var(HUDElement) bool bFadePulse;
> var(HUDElement) bool bFading;
> var(HUDElement) bool bFlashing;
> var bool bNoRender;
> var bool bProgressControlled;
> var(HUDElement) bool bStretched;
> var(HUDElement) MatCoords coords;
> var(HUDElement) Color drawColor;
> var(HUDElement) float fadeDuration;
> var float fadeProgress;
> var(HUDElement) Color fadeSourceColor;
> var float fadeStartTime;
> var(HUDElement) Color fadeTargetColor;
> var(HUDElement) float flashFrequency;
> var float lastFlashTime;
> var(HUDElement) Material material;
> var(HUDElement) byte style;

};

> bFadePulse:

> > Whether to pulse the fade in and out

> bFading:

> > Fading flag

> bFlashing:

> > Flashing flag

> bStretched:

> > Whether the render the material stretched (good for button borders etc)

> coords:

> > Texture coordinates (in pixels) of the location of the desired section in the material

> drawColor:

> > Draw color

> fadeDuration:

> > How long the fade should take in seconds

> fadeSourceColor:

> > Color to fade from

> fadeTargetColor:

> > Color to fade to

> flashFrequency:

> > Frequency of the flash on/off time (in seconds)

> material:

> > Material to eb rendered

> style:

> > Render style - set to 1

Functions Detail

#### Construct Source code

overloaded function Construct ( ) )

#### CreateClonedElement Source code

function HUDElement CreateClonedElement ( string className, string objectName, optional string newObjectName) )

#### CreateHUDElement Source code

function HUDElement CreateHUDElement ( class<HUDElement> elementClass, String elementName, optional Object ownerObject) )

#### DoLayout Source code

event DoLayout ( Canvas c) )

#### EncodeColor Source code

static native function String EncodeColor ( Color InColor )

#### EncodePlayerName Source code

function String EncodePlayerName ( String PlayerName, String TeamTag, ETeamAlignment alignment, optional class<TeamInfo> PlayerTeam) )

#### FlashElement Source code

function FlashElement ( float period, float duration, float AlphaMin, float AlphaMax) )

#### ForceNeedsLayout Source code

event ForceNeedsLayout ( ) )

#### GetAlpha Source code

function float GetAlpha ( ) )

#### GetHeight Source code

function int GetHeight ( ) )

#### GetMaximumRelativeX Source code

function float GetMaximumRelativeX ( ) )

#### GetMaximumRelativeY Source code

function float GetMaximumRelativeY ( ) )

#### GetMaximumX Source code

function float GetMaximumX ( ) )

#### GetMaximumY Source code

function float GetMaximumY ( ) )

#### GetScreenPos Source code

function GetScreenPos ( out int ScreenPosX, out int ScreenPosY) )

#### GetWidth Source code

function int GetWidth ( ) )

#### GetX Source code

function int GetX ( ) )

#### GetY Source code

function int GetY ( ) )

#### InitElement Source code

function InitElement ( ) )

#### InitElementHeirachy Source code

function InitElementHeirachy ( TribesHUDScript base, HUDContainer Parent) )

#### InternalHeight Source code

function int InternalHeight ( ) )

#### InternalLeft Source code

function int InternalLeft ( ) )

#### InternalTop Source code

function int InternalTop ( ) )

#### InternalWidth Source code

function int InternalWidth ( ) )

#### KeyEvent Source code

function bool KeyEvent ( EInputKey Key, EInputAction Action, FLOAT Delta, HUDAction Response )

#### KeyType Source code

function bool KeyType ( EInputKey Key, string Unicode, HUDAction Response )

#### Layout Source code

native function Layout ( Canvas canvas )

#### LoadConfig Source code

native function LoadConfig ( String objectConfigName, class objectClass, optional String Filename )

#### LoadFont Source code

function LoadFont ( String FontName, out Font font) )

#### LoadFonts Source code

function LoadFonts ( ) )

#### MakeHUDMaterial Source code

function HUDMaterial MakeHUDMaterial ( Material mat) )

#### MaterialHeight Source code

function int MaterialHeight ( HUDMaterial mat) )

#### MaterialWidth Source code

function int MaterialWidth ( HUDMaterial mat) )

#### NativeRenderElement Source code

native function NativeRenderElement ( Canvas c )

#### OnMouseClicked Source code

function OnMouseClicked ( HUDElement Sender )

#### OnMouseDoubleClicked Source code

function OnMouseDoubleClicked ( HUDElement Sender )

#### OnMouseEntered Source code

function OnMouseEntered ( HUDElement Sender )

#### OnMouseExited Source code

function OnMouseExited ( HUDElement Sender )

#### PointInElement Source code

function bool PointInElement ( int PointX, int PointY) )

#### PointInRegion Source code

function bool PointInRegion ( int PointX, int PointY, int X1, int Y1, int X2, int Y2) )

#### Render Source code

native function Render ( Canvas c )

#### RenderElement Source code

event RenderElement ( Canvas C) )

#### RenderHUDMaterial Source code

native function RenderHUDMaterial ( Canvas c, out HUDMaterial mat, float matWidth, float matHeight, optional float tileSizeX, optional float tileSizeY )

#### ResetFont Source code

event ResetFont ( ) )

#### ResetHUDMaterial Source code

function ResetHUDMaterial ( out HUDMaterial mat) )

#### ResizeForWidth Source code

native function ResizeForWidth ( Canvas c, int pixelWidth )

#### RootHUDScript Source code

function TribesHUDScript RootHUDScript ( ) )

#### SetAlpha Source code

event SetAlpha ( float newAlpha) )

#### SetColor Source code

function SetColor ( Canvas C, Color newColor) )

#### SetHeight Source code

function SetHeight ( int newHeight) )

#### SetNeedsLayout Source code

event SetNeedsLayout ( ) )

#### SetWidth Source code

function SetWidth ( int newWidth) )

#### SetX Source code

function SetX ( int newX) )

#### SetY Source code

function SetY ( int newY) )

#### StaticCreateHUDElement Source code

static function HUDElement StaticCreateHUDElement ( class<HUDElement> elementClass, String elementName, optional Object ownerObject) )

#### UpdateData Source code

event UpdateData ( ClientSideCharacter c )

Defaultproperties

    defaultproperties
    {
    	alpha = 1
    	bVisible = true
    	bNeedsLayout = true

    	RelativePosX = 0
    	RelativePosY = 0
    	RelativeWidth = 1
    	RelativeHeight = 1

    	verticalFill = VFILL_None
    	horizontalFill = HFILL_None
    	verticalAlignment = VALIGN_None
    	horizontalAlignment = HALIGN_None

    	defaultDrawColor=(R=255,G=255,B=255,A=255)

    	bUseResFonts	= false
    	resFontNames(0)	= DefaultSmallFont
    	resFontNames(1)	= Tahoma8
    	resFontNames(2)	= Tahoma8
    	resFontNames(3)	= Tahoma10
    	resFontNames(4)	= Tahoma12
    	resFontNames(5)	= Tahoma12
    	resFonts(0)		= font'Engine_res.res_defaultFont'
    	resFonts(1)		= font'TribesFonts.Tahoma8'
    	resFonts(2)		= font'TribesFonts.Tahoma8'
    	resFonts(3)		= font'TribesFonts.Tahoma10'
    	resFonts(4)		= font'TribesFonts.Tahoma12'
    	resFonts(5)		= font'TribesFonts.Tahoma12'

    	textFontName	= res_defaultFont
    	textFont		= font'Engine_res.res_defaultFont'
    	textColor		= (R=255,G=255,B=255,A=255)

    	HelpFontName	= Tahoma8
    	HelpFont		= font'TribesFonts.Tahoma8'
    }

Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

Creation time: st 23.5.2018 00:10:30.891 - Created with UnCodeX