Class ClockFrame

Class that deals with time. This is "frame" type clock, the frame increases every ClockFrame#update call.

Param: fps

Frames per second

Hierarchy (View Summary)

Clock
- ClockFrame

Index

Constructors

Properties

__deltaTime __isPlaying __time

Accessors

deltaTime fps frame isPlaying time

Methods

pause play setTime update

Constructors

constructor

new ClockFrame(fps?: number): ClockFrame
Parameters
- fps: number = 60
Returns ClockFrame
Overrides Clock.constructor
- Defined in Clock/ClockFrame.ts:19

Properties

`Protected`__deltaTime

__deltaTime: number = 0.0

Its deltaTime of last update.

`Protected`__isPlaying

__isPlaying: boolean = false

Whether its currently playing or not.

`Protected`__time

__time: number = 0.0

Its current time.

Accessors

deltaTime

get deltaTime(): number
Its deltaTime of last update.

Returns number
Inherited from Clock.deltaTime
- Defined in Clock/Clock.ts:32

fps

get fps(): number
Its fps.

Returns number
- Defined in Clock/ClockFrame.ts:34

frame

get frame(): number
Its current frame.

Returns number
- Defined in Clock/ClockFrame.ts:27

isPlaying

get isPlaying(): boolean
Whether its currently playing or not.

Returns boolean
Inherited from Clock.isPlaying
- Defined in Clock/Clock.ts:39

time

get time(): number
Its current time.

Returns number
Inherited from Clock.time
- Defined in Clock/Clock.ts:25

Methods

pause

pause(): void
Stop the clock.

Returns void
Inherited from Clock.pause
- Defined in Clock/Clock.ts:63

play

play(): void
Start the clock.

Returns void
Inherited from Clock.play
- Defined in Clock/Clock.ts:56

setTime

setTime(time: number): void
Set the time manually. The set time will be converted into internal frame count, so the time will not be exactly same as set one.
Parameters
- time: number
  Time
Returns void
Overrides Clock.setTime
- Defined in Clock/ClockFrame.ts:56

update

update(): void
Update the clock. It will increase the frame by 1.

Returns void
Overrides Clock.update
- Defined in Clock/ClockFrame.ts:41