Class CSPSceneDescription

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::List<csp::common::String> &SceneDescriptionJson)

Constructor for CSPSceneDescription by deserializing a SceneDescription json file.

Warning

The expression of this interface as a list is a wrapper generator workaround, so whilst you may split your string into many elements, it is not advisable. You should prefer inserting your entire string as the first, single, and only element of the list.

Parameters

SceneDescriptionJson – csp::common::String : The SceneDescription to parse.

inline CSPSceneDescription()
csp::common::Array<csp::multiplayer::SpaceEntity*> CreateEntities(csp::common::IRealtimeEngine &RealtimeEngine, csp::common::LogSystem &LogSystem, csp::common::IJSScriptRunner &RemoteScriptRunner) const

Generates an array of entities from the SceneDescription Json This function exists because the construction of SpaceEntites relies on a RealtimeEngine, and the OfflineRealtimeEngine requires a CSPSceneDescription for construction.

Parameters