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

XInterface.GUISubtitleText

Extends
GUILabel

Core.Object
|   
+-- XInterface.GUI
   |   
   +-- XInterface.GUIComponent
      |   
      +-- XInterface.GUILabel
         |   
         +-- XInterface.GUISubtitleText
Variables Summary
intCurLine
eDisplayStateDisplayState
stringSeparator
GUISubtitleText
floatDelayTime
floatGuessCharTime
floatInitialDelay
array<string>SubTitles
array<VisibleDelay>SubTitleTiming
floatVisibleTime
Inherited Variables from XInterface.GUILabel
BackColor, bMultiLine, bTransparent, Caption, FocusedTextColor, HilightColor, HilightOffsetX, HilightOffsetY, ShadowColor, ShadowOffsetX, ShadowOffsetY, TextAlign, TextColor, TextFont, TextStyle, VertAlign
Inherited Variables from XInterface.GUIComponent
bAcceptsInput, bAnimating, bBoundToParent, bCaptureMouse, bCaptureTabs, bDebugging, bDropSource, bDropTarget, bFocusOnWatch, bHasFocus, bInit, bMouseOverSound, bNeverFocus, bNeverScale, BoundingType, Bounds[4], bPendingFocus, bPositioned, bRepeatClick, bRequireReleaseClick, bRequiresStyle, bScaleToParent, bSizing, bStandardized, bTabStop, bTimerRepeat, bTravelling, bVisible, ClientBounds[4], ContextMenu, DrawCount, DropState, FocusInstead, FontScale, FriendlyLabel, Hint, IniDefault, IniOption, LastMenuState, MenuOwner, MenuState, MotionFrame, MouseCursorIndex, MouseOffset[4], OnClickSound, OnDrawCount, OnPreDrawCount, OnRenderCount, OnRenderedCount, PageOwner, PreDrawCount, RenderWeight, ScalingType, SizeFrame, StandardHeight, Style, StyleName, TabOrder, Tag, TimerCountdown, TimerIndex, TimerInterval, ToolTip, WhiteColor, WinHeight, WinLeft, WinTop, WinWidth

Enumerations Summary
eDisplayState
DS_Delay, DS_Visibility, DS_Stopped,
Inherited Enumerations from XInterface.GUIComponent
EClickSound, EParentScaleType

Structures Summary
VisibleDelay
Visible, Delay

Delegates Summary
delegate OnStopped ()
Inherited Delegates from XInterface.GUIComponent
OnActivate, OnArrival, OnBeginDrag, OnBeginTooltip, OnCapturedMouseMove, OnChange, OnClick, OnDblClick, OnDeActivate, OnDesignModeKeyEvent, OnDragDrop, OnDragEnter, OnDragLeave, OnDragOver, OnDraw, OnEndAnimation, OnEndDrag, OnEndTooltip, OnHide, OnHitTest, OnHover, OnInvalidate, OnKeyEvent, OnKeyType, OnLoadINI, OnMessage, OnMousePressed, OnMouseRelease, OnMultiSelect, OnPreDraw, OnRender, OnRendered, OnRightClick, OnSaveINI, OnShow, OnTimer, OnWatch

Functions Summary
functionint AddSubtitle (string NewTitle, optional float delay, optional float Visible)
function ClearSubtitles ()
functionint InsertSubtitle (int position, string NewTitle, optional float delay, optional float Visible)
function Restart ()
functionint SetSubtitles (string alldata, optional string sep, optional bool bDontGuess, optional string lengthdata)
function Stop ()
event Timer ()
Inherited Functions from XInterface.GUIComponent
ActualHeight, ActualLeft, ActualTop, ActualWidth, AdditionalDebugString, Animate, AutoPosition, AutoPositionOn, BeginAnimation, CanAcceptFocus, CenterMouse, Closed, DAnimate, DebugFocus, DebugFocusPosition, DebugTabOrder, DisableComponent, DisableMe, DropStateChange, EnableComponent, EnableMe, EndAnimation, FillOwner, FocusFirst, FocusLast, Free, GetMenuPath, Hide, InitComponent, IsInBounds, IsInClientBounds, IsMultiSelect, KillAnimation, KillTimer, LevelChanged, LoadINI, LoseFocus, MakeColorCode, MenuStateChange, NextControl, NextPage, Opened, OwnerPage, PadLeft, PadRight, PlayerOwner, PrevControl, PrevPage, RelativeHeight, RelativeLeft, RelativeTop, RelativeWidth, Resize, ResolutionChanged, SaveINI, SetFocus, SetFocusInstead, SetFriendlyLabel, SetHint, SetPosition, SetTimer, SetTooltip, SetToolTipText, SetVisibility, Show, SpecialHit, StripColorCodes, Timer, UpdateOffset

Variables Detail

CurLine Source code

var protected int CurLine;

DisplayState Source code

var eDisplayState DisplayState;

Separator Source code

var string Separator;
default seperator

GUISubtitleText

DelayTime Source code

var(GUISubtitleText) float DelayTime;
default delay time

GuessCharTime Source code

var(GUISubtitleText) float GuessCharTime;
use by SetSubTitles to guess the delay, delay = guess time * no. chars

InitialDelay Source code

var(GUISubtitleText) float InitialDelay;
initial delay

SubTitles Source code

var(GUISubtitleText) array<string> SubTitles;
each subtitle on a diffirent line

SubTitleTiming Source code

var(GUISubtitleText) array<VisibleDelay> SubTitleTiming;
time to show a single subtitle

VisibleTime Source code

var(GUISubtitleText) float VisibleTime;
default subtitle visibility, if <= 0 remain visible

Enumerations Detail

eDisplayState Source code

enum eDisplayState
{
DS_Delay, DS_Visibility, DS_Stopped,
};

Structures Detail

VisibleDelay Source code

struct VisibleDelay
{
var float Delay;
var float Visible;
};
Visible is the time this subtitle is vissible Delay is the time to wait to display the next sub title

Delegates Detail

OnStopped Source code

delegate OnStopped ( )

Functions Detail

AddSubtitle Source code

function int AddSubtitle ( string NewTitle, optional float delay, optional float Visible )
Add a subtitle if delay/visible is omitted or 0 the default value is used to have an actual 0 as visible/delay use a negative value

ClearSubtitles Source code

function ClearSubtitles ( )

InsertSubtitle Source code

function int InsertSubtitle ( int position, string NewTitle, optional float delay, optional float Visible )
Insert a subtitle If the position is invalid -1 is returned

Restart Source code

function Restart ( )

SetSubtitles Source code

function int SetSubtitles ( string alldata, optional string sep, optional bool bDontGuess, optional string lengthdata )
Set the subtitles, using default timing if bDontGuess == true lengthdata will be used (uses the same seperator) Return the number of items added

Stop Source code

function Stop ( )

Timer Source code

event Timer ( )

Defaultproperties 

defaultproperties
{
     DelayTime=2.000000
     GuessCharTime=0.060000
     Separator="|"
     TextAlign=TXTA_Center
     bMultiLine=True
     StyleName="TextLabel"
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Wed 7/2/2007 19:16:01.546 - Created with UnCodeX