Scene

consoledoc.h

More...

Internal

bool
bool

Gameplay

string

The name of the gamemode that this scene utilizes.

PostFX

bool

Edit Scene's default Post Effects.

Public Static Attributes

bool

Used to disable the somewhat expensive terrain occlusion testing.

bool

If true, zone culling will be disabled and the scene contents will only be culled against the root frustum.

bool

Debug tool which locks the frustum culling to the current camera location.

int

Maximum number of occluders that will be concurrently allowed into the scene culling state of any given zone.

bool

If true, the bounding boxes of objects will be displayed.

Public Functions

void

Get the root Scene object that is loaded.

void

Get the root Scene object that is loaded.

string

Get the root Scene object that is loaded.

String
getObjectsByClass(String className)

Get the root Scene object that is loaded.

string

Get the root Scene object that is loaded.

int

Get the root Scene object that is loaded.

void

Get the root Scene object that is loaded.

bool
save(string fileName)

Save out the object to the given file.

Detailed Description

UNDOCUMENTED!

Internal

bool isSubScene 
bool isEditing 
bool isDirty 

Gameplay

string gameModeName 

The name of the gamemode that this scene utilizes.

PostFX

bool EditPostEffects 

Edit Scene's default Post Effects.

Public Static Attributes

bool disableTerrainOcclusion 

Used to disable the somewhat expensive terrain occlusion testing.

bool disableZoneCulling 

If true, zone culling will be disabled and the scene contents will only be culled against the root frustum.

bool lockCull 

Debug tool which locks the frustum culling to the current camera location.

int maxOccludersPerZone 

Maximum number of occluders that will be concurrently allowed into the scene culling state of any given zone.

float occluderMinHeightPercentage 

TODO.

float occluderMinWidthPercentage 

TODO.

bool renderBoundingBoxes 

If true, the bounding boxes of objects will be displayed.

Public Functions

addDynamicObject(SceneObject sceneObj)

Get the root Scene object that is loaded.

return:

The id of the Root Scene. Will be 0 if no root scene is loaded

dumpUtilizedAssets()

Get the root Scene object that is loaded.

return:

The id of the Root Scene. Will be 0 if no root scene is loaded

getLevelAsset()

Get the root Scene object that is loaded.

return:

The id of the Root Scene. Will be 0 if no root scene is loaded

getObjectsByClass(String className)

Get the root Scene object that is loaded.

return:

The id of the Root Scene. Will be 0 if no root scene is loaded

getOriginatingFile()

Get the root Scene object that is loaded.

return:

The id of the Root Scene. Will be 0 if no root scene is loaded

getRootScene()

Get the root Scene object that is loaded.

return:

The id of the Root Scene. Will be 0 if no root scene is loaded

removeDynamicObject(SceneObject sceneObj)

Get the root Scene object that is loaded.

return:

The id of the Root Scene. Will be 0 if no root scene is loaded

save(string fileName)

Save out the object to the given file.

Parameters:

fileName

The name of the file to save to.

selectedOnly

If true, only objects marked as selected will be saved out.

preAppendString

Text which will be preprended directly to the object serialization.

True

on success, false on failure.