Mostly Harmless

UE2:CountdownTrigger (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
U2XMP Object >> Actor >> Triggers >> Trigger >> CountdownTrigger
Package: 
U2

CountdownTrigger.uc $Author: Mbaldwin $ $Date: 8/30/02 12:58a $ $Revision: 18 $

Constants[edit]

GenerateEventTimerHandlerName[edit]

Value: 'GenerateEventTimerHandler'


ShowMessageTimerHandlerName[edit]

Value: 'ShowMessageTimerHandler'


ResumeTimerHandlerName[edit]

Value: 'ResumeTimerHandler'


Properties[edit]

Property group 'CountdownTrigger'[edit]

bAppendTimeToMessage[edit]

Type: bool

whether of not to append time to the base message

Default value: True

BaseMessage[edit]

Type: string

BaseMessage

Default value: "T-Minus "

bRepeat[edit]

Type: bool

repeat

bShowLast[edit]

Type: bool

display message for final time (e.g. 0)

bWaitForTrigger[edit]

Type: bool

don't start until triggered

CountdownClearExisting[edit]

Type: bool


CountdownColor[edit]

Type: Object.Color

NOTE: alpha needs to be in 1..255 to have any effect

CountdownFont[edit]

Type: Font


CountdownHolder[edit]

Type: string


CountdownPitch[edit]

Type: float


CountdownSound[edit]

Type: Sound


CountdownTimeEnd[edit]

Type: float

countdown end time

CountdownTimeStart[edit]

Type: float

countdown start time

Default value: 10.0

CountdownVolume[edit]

Type: float


DisplayProps[edit]

Type: array<MessageDisplayInfo>

specifies when and how often sounds should be played

MessageInterval[edit]

Type: float

time between messages

Default value: 1.0

PausedMessage[edit]

Type: string

Message when timer is paused

ResumedMessage[edit]

Type: string

Message when timer is resumed

StatusMessageTime[edit]

Type: float

duration of status messages (defaults to 1/2 of MessageInterval)

Internal variables[edit]

CurState[edit]

Type: EState

Modifiers: protected

current state of the trigger (paused/resumed/uninitialized)

LeftoverTime[edit]

Type: float

Modifiers: protected


MessageCount[edit]

Type: float

Modifiers: protected

total time remaining w.r.t CountdownStart

Default values[edit]

Property Value
Texture Texture'U2.S_CtdTrigger'

Enums[edit]

EState[edit]

CT_STATE_NONE 
CT_STATE_PAUSED 
CT_STATE_RUNNING 

Structs[edit]

MessageDisplayInfo[edit]

float DisplayTimeStart 
when to start using these message/sound properties
float DisplayTimeEnd 
when to end using these message/sound properties
float MessageInterval 
how often to display a message
float StatusMessageTime 
how long to dispaly the message on screen
string BaseMessage 
BaseMessage
Font CountdownFont 
Object.Color CountdownColor 
NOTE: alpha needs to be in 1..255 to have any effect
Sound CountdownSound 
float CountdownVolume 
float CountdownPitch 
string CountdownHolder 

Functions[edit]

Events[edit]

Destroyed[edit]

event Destroyed ()

Overrides: Trigger.Destroyed


PostBeginPlay[edit]

event PostBeginPlay ()

Overrides: Trigger.PostBeginPlay


Other instance functions[edit]

GenerateEventTimerHandler[edit]

function GenerateEventTimerHandler ()


Initialize[edit]

function Initialize ()


Pause[edit]

function Pause ()


RemoveMessageEventTimers[edit]

function RemoveMessageEventTimers ()


Resume[edit]

function Resume ()


ResumeTimerHandler[edit]

function ResumeTimerHandler ()


SecsToTimeString[edit]

function string SecsToTimeString (int Time)


SetCountdownProperties[edit]

function SetCountdownProperties ()


ShowMessage[edit]

function ShowMessage (optional bool bForce)


ShowMessageTimerHandler[edit]

function ShowMessageTimerHandler ()


Trigger[edit]

function Trigger (Actor Other, Pawn EventInstigator, optional name EventName)

Overrides: Actor.Trigger


TriggerActors[edit]

protected function TriggerActors (Actor TriggerSrc, class<ActorTriggerClass, Actor Other, Pawn Instigator, name TriggerEvent, bool bTriggerNPCs)

Overrides: Triggers.TriggerActors


TriggerHandler[edit]

function TriggerHandler ()