From 23574c8e185273ee56c3a5dafeb8f8baa24f2d24 Mon Sep 17 00:00:00 2001 From: technobaboo Date: Thu, 22 Jul 2021 08:57:39 -0500 Subject: [PATCH] Documentation improvements --- docs/stardust-protocol/server/objects/environment.md | 2 ++ docs/stardust-protocol/server/objects/hmd.md | 12 ++++++------ docs/stardust-protocol/server/objects/input.md | 2 +- docs/stardust-protocol/server/objects/lifecycle.md | 3 ++- 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/stardust-protocol/server/objects/environment.md b/docs/stardust-protocol/server/objects/environment.md index 20d33a13..c390ccfa 100644 --- a/docs/stardust-protocol/server/objects/environment.md +++ b/docs/stardust-protocol/server/objects/environment.md @@ -1,5 +1,7 @@ # /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. diff --git a/docs/stardust-protocol/server/objects/hmd.md b/docs/stardust-protocol/server/objects/hmd.md index 533096e7..e83b18bd 100644 --- a/docs/stardust-protocol/server/objects/hmd.md +++ b/docs/stardust-protocol/server/objects/hmd.md @@ -1,9 +1,9 @@ # /hmd -Reference object to the HMD being used to render content and track head position. +Reference object to the HMD being used to render content and track head position. This does not currently work, but is planned to. -## Signals -### `setPosition(Vector3 position)` -### `setRotation(Quaternion rotation)` -### `setPose(Vector3 position, Quaternion rotation)` -### `setIPD(double meters)` + + + + + diff --git a/docs/stardust-protocol/server/objects/input.md b/docs/stardust-protocol/server/objects/input.md index 04d6a873..7d9c8e25 100755 --- a/docs/stardust-protocol/server/objects/input.md +++ b/docs/stardust-protocol/server/objects/input.md @@ -5,6 +5,6 @@ Object managing input and interaction. ## Signals - + ### `registerInputHandler(string name, string field, string spacePath, Vector3 position, Quat rotation, string callbackPath, string callbackMethod)` Creates a new [InputHandler](../types/input/InputHandler.md) with the specified `name` and `field`, located relative to the space referenced in `spacePath` and the `postion` + `rotation`. \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/lifecycle.md b/docs/stardust-protocol/server/objects/lifecycle.md index bd1db5d5..cd64fb1c 100644 --- a/docs/stardust-protocol/server/objects/lifecycle.md +++ b/docs/stardust-protocol/server/objects/lifecycle.md @@ -1,4 +1,5 @@ # /lifecycle + Object representing the life cycle of the Stardust server, from start to each frame to end. ## Signals @@ -7,4 +8,4 @@ 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. +`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).