Initial upload
This commit is contained in:
4
docs/stardust-protocol/server/objects/_category_.json
Normal file
4
docs/stardust-protocol/server/objects/_category_.json
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Server Objects",
|
||||
"position": 2
|
||||
}
|
||||
11
docs/stardust-protocol/server/objects/environment.md
Normal file
11
docs/stardust-protocol/server/objects/environment.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# /environment
|
||||
|
||||
## 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`.
|
||||
11
docs/stardust-protocol/server/objects/field.md
Normal file
11
docs/stardust-protocol/server/objects/field.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# /field
|
||||
|
||||
Object managing fields for interaction.
|
||||
|
||||
## Signals
|
||||
### `createBoxField(string name, Vector3 origin, Quaternion orientation, Vector3 size)`
|
||||
Creates a new [[BoxField]] at `/field/[name]`.
|
||||
|
||||
|
||||
### `createSphereField(string name, Vector3 origin, float radius)`
|
||||
Creates a new [[SphereField]] at `/field/[name]`.
|
||||
9
docs/stardust-protocol/server/objects/hmd.md
Normal file
9
docs/stardust-protocol/server/objects/hmd.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# /hmd
|
||||
|
||||
Reference object to the HMD being used to render content and track head position.
|
||||
|
||||
## Signals
|
||||
### `setPosition(Vector3 position)`
|
||||
### `setRotation(Quaternion rotation)`
|
||||
### `setPose(Vector3 position, Quaternion rotation)`
|
||||
### `setIPD(double meters)`
|
||||
10
docs/stardust-protocol/server/objects/input.md
Executable file
10
docs/stardust-protocol/server/objects/input.md
Executable file
@@ -0,0 +1,10 @@
|
||||
# /input
|
||||
|
||||
Object managing input and interaction.
|
||||
|
||||
## Signals
|
||||
### `registerPointerInput(string name, Vector3 origin, Vector3 direction, float tilt)`
|
||||
Creates a new [[Pointerinput]] at `/input/methods/[name]` with the origin, direction, and tilt specified.
|
||||
|
||||
### `registerInputHandler(string name, string field, string spacePath, Vector3 position, Quat rotation, string callbackPath, string callbackMethod)`
|
||||
Creates a new [[InputHandler]] with the specified `name` and `field`, located relative to the space referenced in `spacePath` and the `postion` + `rotation`.
|
||||
10
docs/stardust-protocol/server/objects/lifecycle.md
Normal file
10
docs/stardust-protocol/server/objects/lifecycle.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# /lifecycle
|
||||
Object representing the life cycle of the Stardust server, from start to each frame to end.
|
||||
|
||||
## Signals
|
||||
### `subscribeLogicStep(string path, string method)`
|
||||
Executes `method` on object at `path` on the client when the main logic loop of the server starts each frame.
|
||||
|
||||
`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.
|
||||
7
docs/stardust-protocol/server/objects/model.md
Normal file
7
docs/stardust-protocol/server/objects/model.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# /model
|
||||
|
||||
Object managing graphical models.
|
||||
|
||||
## Signals
|
||||
### `createFromFile(string name, string path)`
|
||||
Creates a new [[Model]] at `/model/[name]`.
|
||||
7
docs/stardust-protocol/server/objects/spatial.md
Normal file
7
docs/stardust-protocol/server/objects/spatial.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# /spatial
|
||||
|
||||
Object managing spatial nodes for parenting.
|
||||
|
||||
## Signals
|
||||
### `create(string name, Vector3 origin, Quat orientation, Vector3 scale, bool translatable, bool rotatable, bool scalable)`
|
||||
Creates a new [[Spatial]] at `/spatial/[name]`.
|
||||
Reference in New Issue
Block a user