diff --git a/docs/stardust-protocol/server/objects/drawable.md b/docs/stardust-protocol/server/objects/drawable.md new file mode 100644 index 00000000..a793988a --- /dev/null +++ b/docs/stardust-protocol/server/objects/drawable.md @@ -0,0 +1,13 @@ +# /drawable + +Object managing anything drawable, from the skytex to models. + +## Signals +### `createModelFromFile(string name, string spacePath, string path)` +Creates a new [Model](../types/Model.md) at `/model/[name]` with parent at `spacePath`. + +### `setSkytex(string path)` +Sets the sky texture to be the image (HDR) at the absolute `path`. + +### `setSkylight(string path)` +Sets the ambient lighting (using spherical harmonics) to the HDR at the absolute `path`. \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/environment.md b/docs/stardust-protocol/server/objects/environment.md deleted file mode 100644 index c390ccfa..00000000 --- a/docs/stardust-protocol/server/objects/environment.md +++ /dev/null @@ -1,13 +0,0 @@ -# /environment - -Interface managing the skytex and skylight (equivalent of desktop background). - -## Signals -### `visible(bool enable)` -Enable or disables the skybox visibility (lighting remains active). This is not meant to be used for an additive AR mode as StereoKit will perform that when the OpenXR runtime indicates the layer's blend mode is additive. - -### `setSkytex(string path)` -Sets the sky texture to be the image (HDR) at the absolute `path`. - -### `setLighting(string path)` -Sets the ambient lighting (using spherical harmonics) to the HDR at the absolute `path`. \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/model.md b/docs/stardust-protocol/server/objects/model.md deleted file mode 100644 index 873a9dff..00000000 --- a/docs/stardust-protocol/server/objects/model.md +++ /dev/null @@ -1,7 +0,0 @@ -# /model - -Object managing graphical models. - -## Signals -### `createFromFile(string name, string spacePath, string path)` -Creates a new [Model](../types/Model.md) at `/model/[name]` with parent at `spacePath`. \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/lifecycle.md b/docs/stardust-protocol/server/objects/root.md similarity index 69% rename from docs/stardust-protocol/server/objects/lifecycle.md rename to docs/stardust-protocol/server/objects/root.md index cd64fb1c..2b098e22 100644 --- a/docs/stardust-protocol/server/objects/lifecycle.md +++ b/docs/stardust-protocol/server/objects/root.md @@ -1,6 +1,6 @@ -# /lifecycle +# / -Object representing the life cycle of the Stardust server, from start to each frame to end. +Object managing the client/server relationship as a whole. ## Signals ### `subscribeLogicStep(string path, string method)` @@ -9,3 +9,6 @@ Executes `method` on object at `path` on the client when the main logic loop of `method` must have arguments of `(double delta, double timeToRender)`. `delta` gives the time in seconds between the current time and the last time the logic loop executed while `timeToRender` gives the time in ms since epoch when the current frame is expected to reach the user's eyes (returns 0 for now). + +### `disconnect(null)` +Lets the server know that the client wishes to disconnect. After this it can be assumed the client is disconnected from the server. \ No newline at end of file