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

# MojoActions.TsActionSubtitle

Extends
  TsCameraAction

    Core.Object
    |
    +-- MojoCore.TsMojoAction
       |
       +-- MojoActions.TsAction
          |
          +-- MojoActions.TsCameraAction
             |
             +-- MojoActions.TsActionSubtitle

Variables Summary
float | alpha
Font | Font
MessageRouter | Router
string | textString
float | totalTime
TsActionSubtitle
Color | BackgroundColor
int | Center
float | DrawSizeX
float | DrawSizeY
float | DrawX
float | DrawY
float | FadeHoldTime
float | FadeInTime
float | FadeOutTime
string | Filename
string | FontName
Color | ForegroundColor
string | Path
string | SectionName
string | TextName
int | Wrap

Inherited Variables from MojoActions.TsCameraAction
PC

Inherited Variables from MojoActions.TsAction
bShowSubtitles, DisableInMojo, DName, FastForwardSkip, Help, interpolator, interpTime, ModifiesLocation, Track, UsesDuration

Functions Summary
|  | Interrupt ()))
|  | Message (Message msg))
|  | OnDelete ()))
|  | OnFinish ()))
| bool | OnStart ()))
| bool | OnTick (float delta))

Inherited Functions from MojoActions.TsCameraAction
CanBeUsedWith, Start

Inherited Functions from MojoActions.TsAction
CanFastForwardSkip, CanSetDuration, DisableActionInMojo, Finish, GetHelpString, GetLength, GetNameString, GetSummaryString, GetTrackString, Message, ModifiesActorLocation, OnFinish, OnStart, OnTick, resetInterpolation, ShouldShowSubtitles, Start, Tick, tickInterpolation

Variables Detail

#### alpha Source code

var float alpha;

#### Font Source code

var Font Font;

#### Router Source code

var transient MessageRouter Router;

#### textString Source code

var string textString;

#### totalTime Source code

var float totalTime;

### TsActionSubtitle

#### BackgroundColor Source code

var(TsActionSubtitle) Color BackgroundColor;

#### Center Source code

var(TsActionSubtitle) int Center;

> Set to 1 to center the text within the draw area

#### DrawSizeX Source code

var(TsActionSubtitle) float DrawSizeX;

> Choose a value from 0 to 1

#### DrawSizeY Source code

var(TsActionSubtitle) float DrawSizeY;

> Choose a value from 0 to 1

#### DrawX Source code

var(TsActionSubtitle) float DrawX;

> Choose a value from 0 to 1

#### DrawY Source code

var(TsActionSubtitle) float DrawY;

> Choose a value from 0 to 1

#### FadeHoldTime Source code

var(TsActionSubtitle) float FadeHoldTime;

#### FadeInTime Source code

var(TsActionSubtitle) float FadeInTime;

#### FadeOutTime Source code

var(TsActionSubtitle) float FadeOutTime;

#### Filename Source code

var(TsActionSubtitle) string Filename;

> Name of the localization file (do not include the .int)

#### FontName Source code

var(TsActionSubtitle) string FontName;

> Name of font to use

#### ForegroundColor Source code

var(TsActionSubtitle) Color ForegroundColor;

#### Path Source code

var(TsActionSubtitle) string Path;

> The path of the localization file. You don't usually need to change this.

#### SectionName Source code

var(TsActionSubtitle) string SectionName;

> SectionName under which the text resides

#### TextName Source code

var(TsActionSubtitle) string TextName;

> The name of the text to display

#### Wrap Source code

var(TsActionSubtitle) int Wrap;

> Set to 1 to have the text wrap around

Functions Detail

#### Interrupt Source code

function Interrupt ( ) )

#### Message Source code

function Message ( Message msg) )

#### OnDelete Source code

event OnDelete ( ) )

#### OnFinish Source code

function OnFinish ( ) )

#### OnStart Source code

function bool OnStart ( ) )

#### OnTick Source code

function bool OnTick ( float delta) )

Defaultproperties

    defaultproperties
    {
    	DName			="Subtitle"
    	Track			="Effects"
    	Help			="Draws a text subtitle on the screen."

    	SectionName		="Cutscenes"
    	Path			="Localisation/Cutscenes/text files"

    	Font			=Font'Engine_res.Res_DefaultFont'

    	fadeInTime		=1
    	fadeHoldTime	=3
    	fadeOutTime		=1

    	ForegroundColor	=(R=255,G=255,B=255,A=255)
    	BackgroundColor	=(R=0,G=0,B=0,A=0)

    	drawX			=0.1
    	drawY			=0.85
    	drawSizeX		=0.8
    	drawSizeY		=0.2

    	Wrap			=1
    	Center			=1
    }

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

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