Interface ITimeModifier

Namespace: RTSEngine.Determinism

Assembly: cs.temp.dll.dll

Syntax

public interface ITimeModifier : IPreRunGameService

Properties

CanFreezeTimeOnPause

Declaration

bool CanFreezeTimeOnPause { get; }

Property Value

Type	Description
Boolean

CurrOptionIndex

Declaration

int CurrOptionIndex { get; }

Property Value

Type	Description
Int32

Options

Declaration

TimeModifierOptions Options { get; }

Property Value

Type	Description
TimeModifierOptions

Methods

AddTimer(GlobalTimeModifiedTimer, Action)

Declaration

void AddTimer(GlobalTimeModifiedTimer timeModifiedTimer, Action timerThroughCallback)

Parameters

Type	Name	Description
GlobalTimeModifiedTimer	timeModifiedTimer
System.Action	timerThroughCallback

RemoveTimer(GlobalTimeModifiedTimer)

Declaration

void RemoveTimer(GlobalTimeModifiedTimer timer)

Parameters

Type	Name	Description
GlobalTimeModifiedTimer	timer

SetModifier(Single, Boolean)

Declaration

ErrorMessage SetModifier(float newModifier, bool playerCommand)

Parameters

Type	Name	Description
System.Single	newModifier
Boolean	playerCommand

Returns

Type	Description
ErrorMessage

SetModifierLocal(Single, Boolean)

Declaration

ErrorMessage SetModifierLocal(float newModifier, bool playerCommand)

Parameters

Type	Name	Description
System.Single	newModifier
Boolean	playerCommand

Returns

Type	Description
ErrorMessage

SetOptions(TimeModifierOption[], Int32)

Declaration

void SetOptions(TimeModifierOption[] modifierOptions, int initialOptionID)

Parameters

Type	Name	Description
TimeModifierOption[]	modifierOptions
Int32	initialOptionID

Events

ModifierUpdated

Declaration

event CustomEventHandler<ITimeModifier, EventArgs> ModifierUpdated

Event Type

Type	Description
CustomEventHandler<ITimeModifier, System.EventArgs>