Docs: Clarify rotation syntax of model formspec element (#14997)

There has been confusion over this in the past, with users wrongly supplying rotation as `{x,y}`.
This commit is contained in:
Zughy 2024-08-17 15:16:37 +02:00 committed by GitHub
parent d3ca269c79
commit 792fb13ac6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -2861,14 +2861,14 @@ Elements
* Requires formspec version >= 6. * Requires formspec version >= 6.
* See `background9[]` documentation for more information. * See `background9[]` documentation for more information.
### `model[<X>,<Y>;<W>,<H>;<name>;<mesh>;<textures>;<rotation X,Y>;<continuous>;<mouse control>;<frame loop range>;<animation speed>]` ### `model[<X>,<Y>;<W>,<H>;<name>;<mesh>;<textures>;<rotation>;<continuous>;<mouse control>;<frame loop range>;<animation speed>]`
* Show a mesh model. * Show a mesh model.
* `name`: Element name that can be used for styling * `name`: Element name that can be used for styling
* `mesh`: The mesh model to use. * `mesh`: The mesh model to use.
* `textures`: The mesh textures to use according to the mesh materials. * `textures`: The mesh textures to use according to the mesh materials.
Texture names must be separated by commas. Texture names must be separated by commas.
* `rotation {X,Y}` (Optional): Initial rotation of the camera. * `rotation` (Optional): Initial rotation of the camera, format `x,y`.
The axes are euler angles in degrees. The axes are euler angles in degrees.
* `continuous` (Optional): Whether the rotation is continuous. Default `false`. * `continuous` (Optional): Whether the rotation is continuous. Default `false`.
* `mouse control` (Optional): Whether the model can be controlled with the mouse. Default `true`. * `mouse control` (Optional): Whether the model can be controlled with the mouse. Default `true`.