new Clock(viewer)
Handle the time.
Parameters:
| Name | Type | Description |
|---|---|---|
viewer |
FORGE.Viewer | The FORGE.Viewer reference. |
- Source:
Extends
Members
(readonly) alive :boolean
Get the alive flag value of the object.
Type:
- boolean
- Inherited From:
- Source:
(readonly) className :string
Get the class name of the object.
Type:
- string
- Inherited From:
- Source:
data :*
Get and set any custom data you want to associate to this object.
Type:
- *
- Inherited From:
- Source:
debug :boolean
Get and set the debug flag.
Type:
- boolean
- Inherited From:
- Source:
(readonly) onDestroy :FORGE.EventDispatcher
Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
- Inherited From:
- Source:
(readonly) tags :Array
Get the tags associated to this object.
Type:
- Array
- Inherited From:
- Source:
(readonly) uid :string
Get the uid of the object.
Type:
- string
- Inherited From:
- Source:
warning :boolean
Get and set the warning flag.
Type:
- boolean
- Inherited From:
- Source:
Methods
add(timer) → {FORGE.Timer}
Add a FORGE.Timer to the clock.
Parameters:
| Name | Type | Description |
|---|---|---|
timer |
FORGE.Timer | The {FORGE.Timer} to add. |
- Source:
Returns:
The added FORGE.Timer.
- Type
- FORGE.Timer
create(autoDestroy) → {FORGE.Timer}
Create a {FORGE.Timer} for the clock.
Parameters:
| Name | Type | Description |
|---|---|---|
autoDestroy |
boolean | The timer must be destroyed once completed? |
- Source:
Returns:
The created FORGE.Timer.
- Type
- FORGE.Timer
destroy()
Destroy method.
- Overrides:
- Source:
log(value)
Basic log method, log a string in the console if debug is enabled.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
* | The value you want to log in the console. |
- Inherited From:
- Source:
update(time)
Update clock on the main loop.
Parameters:
| Name | Type | Description |
|---|---|---|
time |
number | Time in ms |
- Source:
warn(valuenullable)
Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
string | Object |
<nullable> |
The value you want to warn in the console. |
- Inherited From:
- Source: