StardustXR/website
1
0
Fork 0
Code Issues 3 Pull Requests 4 Actions Packages Projects Releases Wiki Activity

Refine API docs

Browse Source
This commit is contained in:
technobaboo
2021-07-22 08:43:24 -05:00
parent de6a42fc41
commit 163246c267
16 changed files with 45 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/stardust-protocol/server/objects/field.md
View File

@@ -4,8 +4,8 @@ Object managing fields for interaction.
## Signals
### `createBoxField(string name, Vector3 origin, Quaternion orientation, Vector3 size)`
Creates a new [[BoxField]] at `/field/[name]`.
Creates a new [BoxField](../types/field/BoxField.md) at `/field/[name]`.
### `createSphereField(string name, Vector3 origin, float radius)`
Creates a new [[SphereField]] at `/field/[name]`.
Creates a new [SphereField](../types/field/SphereField.md) at `/field/[name]`.

8
docs/stardust-protocol/server/objects/input.md
View File

@@ -3,8 +3,8 @@
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.
<!-- ### `registerPointerInput(string name, Vector3 origin, Vector3 direction, float tilt)` -->
<!-- Creates a new [PointerInput](../types/input/inputtypes/PointerInput.fbs) 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`.
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`.

2
docs/stardust-protocol/server/objects/model.md
View File

@@ -4,4 +4,4 @@ Object managing graphical models.
## Signals
### `createFromFile(string name, string path)`
Creates a new [[Model]] at `/model/[name]`.
Creates a new [Model](../types/Model.md) at `/model/[name]`.

2
docs/stardust-protocol/server/objects/spatial.md
View File

@@ -4,4 +4,4 @@ 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]`.
Creates a new [Spatial](../types/Spatial.md) at `/spatial/[name]`.