Skip to content

Commit

Permalink
docs: schema update with major parsing fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mwfarb committed Mar 27, 2024
1 parent 26db580 commit 14baeae
Show file tree
Hide file tree
Showing 110 changed files with 280 additions and 210 deletions.
2 changes: 1 addition & 1 deletion content/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ These effects are enabled in desktop and XR views. For reference, a list of [all
[s-sound]: /content/schemas/message/sound
[s-spe-particles]: /content/schemas/message/spe-particles
[s-sphere]: /content/schemas/message/sphere
[s-splat]: /content/schemas/message/gaussian-splat
[s-splat]: /content/schemas/message/gaussian_splatting
[s-static-body]: /content/schemas/message/static-body
[s-tetrahedron]: /content/schemas/message/tetrahedron
[s-text]: /content/schemas/message/text
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/arena.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Python API
has_children: true
nav_order: 6.5
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/arena_mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.arena_mqtt
parent: Python API
has_children: true
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes
parent: Python API
has_children: true
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
10 changes: 5 additions & 5 deletions content/python-api/attributes/animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.animation
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand All @@ -25,7 +25,7 @@ grand_parent: Python API
</div>
<a class="headerlink" href="#Animation"></a>

<div class="docstring"><p>Animation attribute class to manage its properties in the ARENA: Animate and tween values. More properties at (<a href="https://aframe.io/docs/1.5.0/components/animation.html">https://aframe.io/docs/1.5.0/components/animation.html</a>) A-Frame Animation component. Easing properties are detailed at (<a href="https://easings.net">https://easings.net</a>) easings.net.
<div class="docstring"><p>Animation attribute class to manage its properties in the ARENA: Animate and tween values. More properties at <a href="https://aframe.io/docs/1.5.0/components/animation.html">https://aframe.io/docs/1.5.0/components/animation.html</a> A-Frame Animation component. Easing properties are detailed at <a href="https://easings.net">https://easings.net</a> easings.net.
Usage: animation=Animation(...)</p>

<h6 id="parameters">Parameters</h6>
Expand All @@ -41,11 +41,11 @@ Usage: animation=Animation(...)</p>
<li><strong>str from</strong>: Initial value at start of animation. If not specified, the current property value of the entity will be used (will be sampled on each animation start). It is best to specify a from value when possible for stability. (optional)</li>
<li><strong>bool isRawProperty</strong>: Flag to animate an arbitrary object property outside of A-Frame components for better performance. If set to true, for example, we can set property to like components.material.material.opacity. If property starts with components or object3D, this will be inferred to true. (optional)</li>
<li><strong>str loop</strong>: How many times the animation should repeat. If the value is true, the animation will repeat infinitely. (optional)</li>
<li><strong>list[dict] pauseEvents</strong>: Comma-separated list of events to listen to trigger pause. Can be resumed with resumeEvents. (optional)</li>
<li><strong>list[str] pauseEvents</strong>: Comma-separated list of events to listen to trigger pause. Can be resumed with resumeEvents. (optional)</li>
<li><strong>str property</strong>: Property to animate. Can be a component name, a dot-delimited property of a component (e.g., material.color), or a plain attribute. (optional)</li>
<li><strong>list[dict] resumeEvents</strong>: Comma-separated list of events to listen to trigger resume after pausing. (optional)</li>
<li><strong>list[str] resumeEvents</strong>: Comma-separated list of events to listen to trigger resume after pausing. (optional)</li>
<li><strong>bool round</strong>: Whether to round values. (optional)</li>
<li><strong>list[dict] startEvents</strong>: Comma-separated list of events to listen to trigger a restart and play. Animation will not autoplay if specified. startEvents will restart the animation, use pauseEvents to resume it. If there are other animation components on the entity animating the same property, those animations will be automatically paused to not conflict. (optional)</li>
<li><strong>list[str] startEvents</strong>: Comma-separated list of events to listen to trigger a restart and play. Animation will not autoplay if specified. startEvents will restart the animation, use pauseEvents to resume it. If there are other animation components on the entity animating the same property, those animations will be automatically paused to not conflict. (optional)</li>
<li><strong>str to</strong>: Target value at end of animation. (optional)</li>
<li><strong>str type</strong>: Right now only supports color for tweening isRawProperty color XYZ/RGB vector values. (optional)</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions content/python-api/attributes/animation_mixer.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.animation_mixer
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand All @@ -25,7 +25,7 @@ grand_parent: Python API
</div>
<a class="headerlink" href="#AnimationMixer"></a>

<div class="docstring"><p>AnimationMixer attribute class to manage its properties in the ARENA: A list of available animations can usually be found by inspecting the model file or its documentation. All animations will play by default. To play only a specific set of animations, use wildcards: animation-mixer='clip: run_*'. More properties at (<a href="https://github.com/n5ro/aframe-extras/tree/master/src/loaders#animation">https://github.com/n5ro/aframe-extras/tree/master/src/loaders#animation</a>) A-Frame Extras Animation.
<div class="docstring"><p>AnimationMixer attribute class to manage its properties in the ARENA: A list of available animations can usually be found by inspecting the model file or its documentation. All animations will play by default. To play only a specific set of animations, use wildcards: animation-mixer='clip: run_*'. More properties at <a href="https://github.com/n5ro/aframe-extras/tree/master/src/loaders#animation">https://github.com/n5ro/aframe-extras/tree/master/src/loaders#animation</a> A-Frame Extras Animation.
Usage: animation_mixer=AnimationMixer(...)</p>

<h6 id="parameters">Parameters</h6>
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/attributes/armarker.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.armarker
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/attributes/attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.attribute
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/attributes/attribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.attribution
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/attributes/blip.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.blip
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/attributes/box_collision_listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.box_collision_listener
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
8 changes: 4 additions & 4 deletions content/python-api/attributes/click_listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.click_listener
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand All @@ -25,13 +25,13 @@ grand_parent: Python API
</div>
<a class="headerlink" href="#ClickListener"></a>

<div class="docstring"><p>ClickListener attribute class to manage its properties in the ARENA: Object will listen for clicks.
Usage: click_listener=ClickListener(...) or clickable=ClickListener(...) or clickable=True</p>
<div class="docstring"><p>ClickListener attribute class to manage its properties in the ARENA: Object will listen for mouse events like clicks.
Usage: click_listener=ClickListener(...)</p>

<h6 id="parameters">Parameters</h6>

<ul>
<li>**bool bubble: Set false to prevent click events from bubbling up to parent objects. See <a href='https**: //developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events#event_bubbling'>Event Bubbling</a>. Defaults to 'True' (optional)</li>
<li><strong>bool bubble: Set false to prevent click events from bubbling up to parent objects. See <https</strong>: //developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events#event_bubbling> Event Bubbling. Defaults to 'True' (optional)</li>
<li><strong>bool enabled</strong>: Publish events, set false to disable. Defaults to 'True' (optional)</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion content/python-api/attributes/color.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: arena.attributes.color
parent: arena.attributes
grand_parent: Python API
---
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.0/arena">v0.9.0</a></small>
<small>arena-py API <a href="https://github.com/arenaxr/arena-py/blob/v0.9.3/arena">v0.9.3</a></small>
<div>
<main class="pdoc">
<section class="module-info">
Expand Down
Loading

0 comments on commit 14baeae

Please sign in to comment.