Class CSPSceneDescription

Defined in File CSPSceneDescription.h

Class Documentation

class CSPSceneDescription

CSPSceneDescription which represents all entities that exists for a scene.

This data structure is created through the deserialization of a CSPSceneDescription Json which is retrieved externally. The json file used to create this structure is also used to create a systems::CSPSceneData object. The reason these are seperated is to break dependencies between our multiplayer and corer modules.

Public Functions

CSPSceneDescription(const csp::common::String &SceneDescriptionJson, csp::multiplayer::SpaceEntitySystem &EntitySystem, csp::common::LogSystem &LogSystem, csp::common::IJSScriptRunner &RemoteScriptRunner)

Constructor for CSPSceneDescription by deserializing a SceneDescription json file.

Parameters

SceneDescriptionJson – csp::common::String : The SceneDescription to deserialize.
EntitySystem – csp::multiplayer::SpaceEntitySystem& : The SpaceEntitySystem for this session.
LogSystem – csp::common::LogSystem& : The SpaceEntitySystem for this session.
RemoteScriptRunner – csp::common::IJSScriptRunner& : The ScriptRunner for this session.

Public Members

csp::common::Array<csp::multiplayer::SpaceEntity*> Entities: The Entities that exist for this scene.