Digital Spaces Interfaces API
Welcome to the Digital Spaces API documentation.
- Version:
- 0.11.0
If you are reading this, you are probably looking to do some development, either using Digital Spaces (also known as DSS) as the engine to drive your content, or you're looking to develop a component for Digital Spaces, to improve or add functionality.
The way to distinguish between these two styles of development really depends on how the logic you are developing is going to interact with the system. If your logic is purely control logic, then you are developing with Digital Spaces. On a technical level, if your code will call components, but no component will call your code (other then certain event callbacks), then you are developing with Digital Spaces.
Almost any other kind of interaction must currently be considered developing for Digital Spaces. From a technical point of view, if your logic will be called by other components, particularly via GetFactoriesWithInterface, then it fits in the second category.
When developing with Digital Spaces, to use it to run your content, you have two main choices on how to proceed. The first is to build a component in C/C++. The second is to use the Python Interpreter that the Script_Python component provides. We highly recommend using the Python Interpreter as it is easier to get started with, and to rapidly develop in. The only issue is execution speed, and generally it is not as much of an issue as expected when thinking of scripting (Python is generally considered to run at 50% speed of compiled code). The Python API has access to most of the functionality that the C++ API does, except for some functions that require the more complex container objects (such as XML). We hope to improve this in future, to make the Python API fully comparable to the binary API.
- Todo:
- Fill this out
- Todo:
- Creating a component
- Todo:
- Providing new DInterfaces
- Todo:
- Agent Behaviours