Skip to content

Commit

Permalink
docs: update message schema deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
mwfarb committed Oct 15, 2024
1 parent e9ab1f7 commit 0fbccb6
Show file tree
Hide file tree
Showing 75 changed files with 1,937 additions and 1,818 deletions.
16 changes: 8 additions & 8 deletions content/schemas/message/animation-mixer.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Animation Mixer Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|clampWhenFinished|boolean|```False```|If true, halts the animation at the last frame.|No|
|clip|string|```'*'```|Name of the animation clip(s) to play. Accepts wildcards.|Yes|
|crossFadeDuration|number|```0```|Duration of cross-fades between clips, in seconds.|No|
|duration|number|```0```|Duration of the animation, in seconds (0 = auto).|No|
|loop|string; One of: ```['once', 'repeat', 'pingpong']```|```'repeat'```|In repeat and pingpong modes, the clip plays once plus the specified number of repetitions. For pingpong, every second clip plays in reverse.|No|
|repetitions|string|```''```|Number of times to play the clip, in addition to the first play (empty string = Infinity). Repetitions are ignored for loop: once.|No|
|startAt|number|```0```|Sets the start of an animation to a specific time (in milliseconds). This is useful when you need to jump to an exact time in an animation. The input parameter will be scaled by the mixer's timeScale.|No|
|timeScale|number|```1```|Scaling factor for playback speed. A value of 0 causes the animation to pause. Negative values cause the animation to play backwards.|No|
|**clampWhenFinished**|boolean|```False```|If true, halts the animation at the last frame.|No|
|**clip**|string|```'*'```|Name of the animation clip(s) to play. Accepts wildcards.|Yes|
|**crossFadeDuration**|number|```0```|Duration of cross-fades between clips, in seconds.|No|
|**duration**|number|```0```|Duration of the animation, in seconds (0 = auto).|No|
|**loop**|string; One of: ```['once', 'repeat', 'pingpong']```|```'repeat'```|In repeat and pingpong modes, the clip plays once plus the specified number of repetitions. For pingpong, every second clip plays in reverse.|No|
|**repetitions**|string|```''```|Number of times to play the clip, in addition to the first play (empty string = Infinity). Repetitions are ignored for loop: once.|No|
|**startAt**|number|```0```|Sets the start of an animation to a specific time (in milliseconds). This is useful when you need to jump to an exact time in an animation. The input parameter will be scaled by the mixer's timeScale.|No|
|**timeScale**|number|```1```|Scaling factor for playback speed. A value of 0 causes the animation to pause. Negative values cause the animation to play backwards.|No|
34 changes: 17 additions & 17 deletions content/schemas/message/animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ Animation Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|autoplay|boolean|```True```|Whether or not the animation should autoplay. Should be specified if the animation is defined for the animation-timeline component (currently not supported).|No|
|delay|number|```0```|How long (milliseconds) to wait before starting.|No|
|dir|string; One of: ```['normal', 'alternate', 'reverse']```|```'normal'```|Which dir to go from from to to.|No|
|dur|number|```1000```|How long (milliseconds) each cycle of the animation is.|No|
|easing|string; One of: ```['easeInQuad', 'easeInCubic', 'easeInQuart', 'easeInQuint', 'easeInSine', 'easeInExpo', 'easeInCirc', 'easeInBack', 'easeInElastic', 'easeOutQuad', 'easeOutCubic', 'easeOutQuart', 'easeOutQuint', 'easeOutSine', 'easeOutExpo', 'easeOutCirc', 'easeOutBack', 'easeOutElastic', 'easeInOutQuad', 'easeInOutCubic', 'easeInOutQuart', 'easeInOutQuint', 'easeInOutSine', 'easeInOutExpo', 'easeInOutCirc', 'easeInOutBack', 'easeInOutElastic', 'linear']```|```'easeInQuad'```|Easing function of animation. To ease in, ease out, ease in and out. See easings.net for more.|No|
|elasticity|number|```400```|How much to bounce (higher is stronger).|No|
|enabled|boolean|```True```|If disabled, animation will stop and startEvents will not trigger animation start.|No|
|from|string|```''```|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.|No|
|isRawProperty|boolean|```False```|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.|No|
|loop|string|```'0'```|How many times the animation should repeat. If the value is true, the animation will repeat infinitely.|No|
|pauseEvents|array|```[]```|Comma-separated list of events to listen to trigger pause. Can be resumed with resumeEvents.|No|
|property|string||Property to animate. Can be a component name, a dot-delimited property of a component (e.g., material.color), or a plain attribute.|No|
|resumeEvents|array|```[]```|Comma-separated list of events to listen to trigger resume after pausing.|No|
|round|boolean|```False```|Whether to round values.|No|
|startEvents|array|```[]```|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.|No|
|to|string|```''```|Target value at end of animation.|No|
|type|string|```''```|Right now only supports color for tweening isRawProperty color XYZ/RGB vector values.|No|
|**autoplay**|boolean|```True```|Whether or not the animation should autoplay. Should be specified if the animation is defined for the animation-timeline component (currently not supported).|No|
|**delay**|number|```0```|How long (milliseconds) to wait before starting.|No|
|**dir**|string; One of: ```['normal', 'alternate', 'reverse']```|```'normal'```|Which dir to go from from to to.|No|
|**dur**|number|```1000```|How long (milliseconds) each cycle of the animation is.|No|
|**easing**|string; One of: ```['easeInQuad', 'easeInCubic', 'easeInQuart', 'easeInQuint', 'easeInSine', 'easeInExpo', 'easeInCirc', 'easeInBack', 'easeInElastic', 'easeOutQuad', 'easeOutCubic', 'easeOutQuart', 'easeOutQuint', 'easeOutSine', 'easeOutExpo', 'easeOutCirc', 'easeOutBack', 'easeOutElastic', 'easeInOutQuad', 'easeInOutCubic', 'easeInOutQuart', 'easeInOutQuint', 'easeInOutSine', 'easeInOutExpo', 'easeInOutCirc', 'easeInOutBack', 'easeInOutElastic', 'linear']```|```'easeInQuad'```|Easing function of animation. To ease in, ease out, ease in and out. See easings.net for more.|No|
|**elasticity**|number|```400```|How much to bounce (higher is stronger).|No|
|**enabled**|boolean|```True```|If disabled, animation will stop and startEvents will not trigger animation start.|No|
|**from**|string|```''```|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.|No|
|**isRawProperty**|boolean|```False```|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.|No|
|**loop**|string|```'0'```|How many times the animation should repeat. If the value is true, the animation will repeat infinitely.|No|
|**pauseEvents**|array|```[]```|Comma-separated list of events to listen to trigger pause. Can be resumed with resumeEvents.|No|
|**property**|string||Property to animate. Can be a component name, a dot-delimited property of a component (e.g., material.color), or a plain attribute.|No|
|**resumeEvents**|array|```[]```|Comma-separated list of events to listen to trigger resume after pausing.|No|
|**round**|boolean|```False```|Whether to round values.|No|
|**startEvents**|array|```[]```|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.|No|
|**to**|string|```''```|Target value at end of animation.|No|
|**type**|string|```''```|Right now only supports color for tweening isRawProperty color XYZ/RGB vector values.|No|
18 changes: 9 additions & 9 deletions content/schemas/message/arena-scene-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ Scene Config Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|object_id|string|```'scene-options'```|A uuid or otherwise unique identifier for this object.|Yes|
|persist|boolean|```True```|Persist this object in the database.|Yes|
|type|string; Must be: ```scene-options```|```'scene-options'```|ARENA scene options|Yes|
|action|string; One of: ```['create', 'delete', 'update']```|```'create'```|Message action create, update, delete.|Yes|
|data|Scene Config data||Scene Config Data|Yes|
|**object_id**|string|```'scene-options'```|A uuid or otherwise unique identifier for this object.|Yes|
|**persist**|boolean|```True```|Persist this object in the database.|Yes|
|**type**|string; Must be: ```scene-options```|```'scene-options'```|ARENA scene options|Yes|
|**action**|string; One of: ```['create', 'delete', 'update']```|```'create'```|Message action create, update, delete.|Yes|
|**data**|Scene Config data||Scene Config Data|Yes|

### Scene Config Data Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|env-presets|[env-presets](env-presets)||A-Frame Environment presets.|Yes|
|renderer-settings|[renderer-settings](renderer-settings)||These settings are fed into three.js WebGLRenderer properties.|No|
|scene-options|[scene-options](scene-options)||ARENA Scene Options.|Yes|
|post-processing|[post-processing](post-processing)||These effects are enabled in desktop and XR views.|No|
|**env-presets**|[env-presets](env-presets)||A-Frame Environment presets.|Yes|
|**renderer-settings**|[renderer-settings](renderer-settings)||These settings are fed into three.js WebGLRenderer properties.|No|
|**scene-options**|[scene-options](scene-options)||ARENA Scene Options.|Yes|
|**post-processing**|[post-processing](post-processing)||These effects are enabled in desktop and XR views.|No|
16 changes: 8 additions & 8 deletions content/schemas/message/arena-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ User Avatar Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|displayName|string|```''```|User display name.|Yes|
|color|string|```'white'```|The color for the user's name text.|Yes|
|headModelPath|string|```'/static/models/avatars/robobit.glb'```|Path to user avatar head model.|Yes|
|presence|string; One of: ```['Standard', 'Portal']```|```'Standard'```|Type of presence for user.|No|
|jitsiId|string|```''```|User Jitsi ID.|No|
|hasAudio|bool|```False```|Whether the user has audio on.|No|
|hasVideo|bool|```False```|Whether the user has video on.|No|
|hasAvatar|bool|```False```|Whether the user has facial feature capture on.|No|
|**displayName**|string|```''```|User display name.|Yes|
|**color**|string|```'white'```|The color for the user's name text.|Yes|
|**headModelPath**|string|```'/static/models/avatars/robobit.glb'```|Path to user avatar head model.|Yes|
|**presence**|string; One of: ```['Standard', 'Portal']```|```'Standard'```|Type of presence for user.|No|
|**jitsiId**|string|```''```|User Jitsi ID.|No|
|**hasAudio**|bool|```False```|Whether the user has audio on.|No|
|**hasVideo**|bool|```False```|Whether the user has video on.|No|
|**hasAvatar**|bool|```False```|Whether the user has facial feature capture on.|No|
Loading

0 comments on commit 0fbccb6

Please sign in to comment.