UE2:CountdownTrigger (U2XMP)

Object >> Actor >> Triggers >> Trigger >> CountdownTrigger

Package: 

U2

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

Constants

GenerateEventTimerHandlerName

Value: 'GenerateEventTimerHandler'

ShowMessageTimerHandlerName

Value: 'ShowMessageTimerHandler'

ResumeTimerHandlerName

Value: 'ResumeTimerHandler'

Properties

Property group 'CountdownTrigger'

bAppendTimeToMessage

Type: bool

whether of not to append time to the base message

Default value: True

BaseMessage

Type: string

BaseMessage

Default value: "T-Minus "

bRepeat

Type: bool

repeat

bShowLast

Type: bool

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

bWaitForTrigger

Type: bool

don't start until triggered

CountdownClearExisting

Type: bool

CountdownColor

Type: Object.Color

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

CountdownFont

Type: Font

CountdownHolder

Type: string

CountdownPitch

Type: float

CountdownSound

Type: Sound

CountdownTimeEnd

Type: float

countdown end time

CountdownTimeStart

Type: float

countdown start time

Default value: 10.0

CountdownVolume

Type: float

DisplayProps

Type: array<MessageDisplayInfo>

specifies when and how often sounds should be played

MessageInterval

Type: float

time between messages

Default value: 1.0

PausedMessage

Type: string

Message when timer is paused

ResumedMessage

Type: string

Message when timer is resumed

StatusMessageTime

Type: float

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

Internal variables

CurState

Type: EState

Modifiers: protected

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

LeftoverTime

Type: float

Modifiers: protected

MessageCount

Type: float

Modifiers: protected

total time remaining w.r.t CountdownStart

Default values

Property	Value
Texture	Texture'U2.S_CtdTrigger'

Enums

EState

CT_STATE_NONE 

CT_STATE_PAUSED 

CT_STATE_RUNNING 

Structs

MessageDisplayInfo

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

Events

Destroyed

event Destroyed ()

Overrides: Trigger.Destroyed

PostBeginPlay

event PostBeginPlay ()

Overrides: Trigger.PostBeginPlay

Other instance functions

GenerateEventTimerHandler

function GenerateEventTimerHandler ()

Initialize

function Initialize ()

Pause

function Pause ()

RemoveMessageEventTimers

function RemoveMessageEventTimers ()

Resume

function Resume ()

ResumeTimerHandler

function ResumeTimerHandler ()

SecsToTimeString

function string SecsToTimeString (int Time)

SetCountdownProperties

function SetCountdownProperties ()

ShowMessage

function ShowMessage (optional bool bForce)

ShowMessageTimerHandler

function ShowMessageTimerHandler ()

Trigger

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

Overrides: Actor.Trigger

TriggerActors

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

Overrides: Triggers.TriggerActors

TriggerHandler

function TriggerHandler ()