Namespace sandboxe.engine
Defined in: docbase.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Collection of fuctions to work with the engine in general
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
sandboxe.engine.getTotalTime
Returns the total number of MS since sandboxe started.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
sandboxe.engine.attachManager(manager)
Attaches a manager-type entity to the engine.
|
| <static> |
sandboxe.engine.getBaseDirectory()
Returns the base directory of the binary.
|
| <static> |
sandboxe.engine.getRoot()
Gets the current entity that is set as the root.
|
| <static> |
sandboxe.engine.quit()
Terminates the program.
|
| <static> |
sandboxe.engine.setMaxFPS(FPS)
Sets the maximum update rate of the engine.
|
| <static> |
sandboxe.engine.setRoot(root)
Sets the root of the entity hierarchy.
|
| <static> |
sandboxe.engine.version()
Returns a version string for the engine.
|
Field Detail
<static>
{Number}
sandboxe.engine.getTotalTime
Returns the total number of MS since sandboxe started.
Method Detail
<static>
sandboxe.engine.attachManager(manager)
Attaches a manager-type entity to the engine.
Normally, the entity hierarchy is used for normal objects; however,
sometimes it is useful to have management objects that are
separate from the hierarchy. attachManager() does all the
management of a given entity is if it were in the hierarchy without
exposing it to hierarchy attributes (i.e. inspection in the debugger,
inheriting transforms, etc.)
- Parameters:
- {entity} manager
- The management-type entity to insert into the engine.
<static>
{String}
sandboxe.engine.getBaseDirectory()
Returns the base directory of the binary. This serves as the root path for
any specified relative paths given to sandboxe. It is equivalent to the
starting directory of the binary. On environments where this doesn't make sense,
an empty string is returned.
- Returns:
- {String} The base path.
<static>
{entity}
sandboxe.engine.getRoot()
Gets the current entity that is set as the root. See sandbose.engine.setRoot.
- Returns:
- {entity}
<static>
sandboxe.engine.quit()
Terminates the program.
<static>
sandboxe.engine.setMaxFPS(FPS)
Sets the maximum update rate of the engine. The default is 60 FPS (frames per second).
In sandboxe, the step and frame rate are coupled.
- Parameters:
- {Number} FPS
- The new amount to set.
<static>
sandboxe.engine.setRoot(root)
Sets the root of the entity hierarchy.
For normal, automatic updating of an entity by the engine, an entity needs to be
either the root of the hierarchy or a child within the hierarchy.
Once this is the case, the stepping and drawing behavior for entities will be
called at regular intervals. Once in the hierarchy, the entity may also be
inspected through the runtime debugger (F3).
- Parameters:
- {entity} root
- The new root of the emtity hierarchy.
<static>
{String}
sandboxe.engine.version()
Returns a version string for the engine.
- Returns:
- {String} The version.