Tags

The ID of the bot that created this bot. The creator bot must be in the same space as this bot.

Behavior Tags

These tags affect how CasualOS allows the users to interact with bots.

`draggable`

Whether the bot is able to be moved by the built-in CasualOS system.

Note that this value only controls whether CasualOS can move bots automatically as the result of user interaction. If set to false, then CasualOS will not change any tags, but it will still send events for the bot (e.g. @onDrag, @onAnyBotDrag, @onDrop, @onAnyBotDrop, etc.).

Possible values are:

Value	Description
`true`	The bot is able to be dragged. (default)
`false`	The bot cannot be dragged.

`pointable`

Whether the bot interacts with the pointer.

Bots that are pointable can receive clicks, pointer enter/exit, and drop events. Note that the #pointable tag also affects whether the content inside an iframe form is interactable.

Possible values are:

Value	Description
`true`	The bot interacts with the pointer. (default)
`false`	The bot does not interact with the pointer.

`focusable`

Whether the bot is able to be focused.

Bots that are focusable can receive focus events like @onFocusEnter.

Possible values are:

Value	Description
`true`	The bot is focusable. (default)
`false`	The bot is not focusable.

`destroyable`

Whether the bot is able to be destroyed.

Possible values are:

Value	Description
`true`	The bot will be able to be destroyed. (default)
`false`	The bot will not be able to be destroyed.

`editable`

Whether the bot is able to be edited in the sheet in Channel Designer.

Use with caution. Once you set #editable to false, you can't edit the bot via the sheet.

Possible values are:

Value	Description
`true`	The bot can be edited via the sheet. (default)
`false`	The bot cannot be edited via the sheet. (including being able to set editable back to true)

`listening`

Determines whether this bot responds to whispers or shouts. If this tag is set to true it will respond to them. If set to false, it will not.

Possible values are:

Value	Description
`true`	The bot will respond to whispers and shouts. (default)
`false`	The bot will not respond to whispers or shouts.

`system`

The "system" that this bot represents. Bots with a #system tag will be able to appear in the systemPortal. The you can kinda think of the #system tag as the name that the systemPortal uses for bots. #system tag values should ideally be three sections separated by a ..

Note that this tag can be changed by using the #systemTagName tag.

For example, the first section might be the name of the app bundle, the second section would be the area that the bot belongs in, and the third section would be the name of the bot. e.g. myAppBundle.managers.timeline would specify that a bot belongs in myAppBundle and is one of the manager bots. The systemPortal would then show each bot organized by #system tag.

Image of bots in the systemPortal

Possible values are:

Value	Description
`null`	(default)
Any String	The system that this bot belongs to.

Visualization Tags

These tags change how CasualOS displays bots.

`color`

The color of the bot.

Possible values are:

Value	Description
`white`	(default)
`#858585`	(default for keyboards)
Any X11 Color	X11 colors are a list of standard colors that web browsers support.
Any Hex Color	Hex colors are three or six digit numbers that specify a color by its red, green, and blue components.
`clear`	The bot's body will be invisible.

`cursor`

The cursor that should be used when the mouse pointer is hovering over the bot in the bot and menu portals.

Note that when using a custom cursor image, the image should be 32x32 pixels or smaller. This is because that is the largest cursor image size that some operating systems support.

Possible values are:

Value	Description
`auto`	The cursor automatically changes its look based on the context. For grid portal bots, this means that the arrow cursor is used. For menu portal bots, this means that the pointer is used when the bot has a `@onClick` and the arrow is used otherwise. (default)
`default`	The cursor looks like the default cursor for the platform. Generally, this means the arrow cursor.
`none`	The cursor is invisible.
`wait`	wait
`context-menu`	context-menu
`help`	help
`pointer`	pointer
`progress`	progress
`cell`	cell
`crosshair`	crosshair
`text`	text
`vertical-text`	vertical-text
`alias`	alias
`copy`	copy
`move`	move
`no-drop`	no-drop
`not-allowed`	not-allowed
`grab`	grab
`grabbing`	grabbing
`all-scroll`	all-scroll
`col-resize`	col-resize
`row-resize`	row-resize
`n-resize`	n-resize
`e-resize`	e-resize
`s-resize`	s-resize
`w-resize`	w-resize
`ne-resize`	ne-resize
`nw-resize`	nw-resize
`se-resize`	se-resize
`sw-resize`	sw-resize
`ew-resize`	ew-resize
`ns-resize`	ns-resize
`nesw-resize`	nesw-resize
`nwse-resize`	nwse-resize
`zoom-in`	zoom-in
`zoom-out`	zoom-out
Any URL	The image at the given URL will be used as the cursor. Images should be 32x32 pixels or smaller otherwise they may not work.

`cursorHotspot`

The X and Y position of the pixel in the cursor image that is the "hotspot". That is, the pixel which represents the point or tip of the cursor.

The top left of the image is (0, 0).

Possible values are:

Value	Description
`➡️0,0`	(default)
Any Vector > ➡️0,0	The position that the cursor hotspot should be at.

`strokeColor`

The color of the bot's outline.

Possible values are:

Value	Description
`clear`	(default)
Any X11 Color	X11 colors are a list of standard colors that web browsers support.
Any Hex Color	Hex colors are three or six digit numbers that specify a color by its red, green, and blue components.

`strokeWidth`

The width of the bot's outline.

`lineTo`

The bot, bot ID, list of bots, or list of bot IDs that this bot should draw lines to.

`lineStyle`

The style of the lines.

Possible values are:

Value	Description
`line`	Displays the line without additional decoration. (Default)
`arrow`	Displays the line with an arrow at the tip pointing to the target bot.
`wall`	Displays the line as a vertical wall.

`lineWidth`

The width of the lines from this bot.

Possible values are:

Value	Description
`1`	The width of the line is 1 unit. (default)
Any Number > 0	The width of the line is the given size.

`lineColor`

The color of the lines.

Possible values are:

Value	Description
`white`	(default)
Any X11 Color	X11 colors are a list of standard colors that web browsers support.
Any Hex Color	Hex colors are three or six digit numbers that specify a color by its red, green, and blue components.

`label`

The text that the bot should show in a label.

`labelColor`

The color of the text in the label.

Possible values are:

Value	Description
`black`	(default)
Any X11 Color	X11 colors are a list of standard colors that web browsers support.
Any Hex Color	Hex colors are three or six digit numbers that specify a color by its red, green, and blue components.

`labelOpacity`

The opacity of the text in the label.

Possible values are:

Value	Description
`1`	(default)
Any Number >= 0 and <= 1	The label will use the given opacity.

`labelFontSize`

The font size of the text in the label. Changing this value scales the text characters in the label which changes the text layout.

Possible values are:

Value	Description
`auto`	The label font size is automatically scaled to fit the text in the bot. (Default)
Any Number > 0	The label will use the given font size.

`labelPadding`

The amount of space that should be between the edge of the bot and the edge of the label. Units are in grid spaces.

When #labelFontSize is set to auto, this setting affects both the label height and width. Otherwise, it only affects the width.

Possible values are:

Value	Description
`0`	There is no space between the edge of the bot and the edge of the label. (Default)
Any Number > 0	The label is sized so that it fits in the space provided by the bot minus the padding.

`labelPaddingX`

The amount of space that should be between the side of the bot and the side of the label. Units are in grid spaces.

This tag is similar to #labelPadding except that it only affects the width of the label.

Possible values are:

Value	Description
`0`	There is no space between the edge of the bot and the edge of the label. (Default)
Any Number > 0	The label is sized so that it fits in the space provided by the bot minus the padding.

`labelPaddingY`

The amount of space that should be between the top of the bot and the top of the label. Units are in grid spaces.

This tag is similar to #labelPadding except that it only affects the height of the label. As such, this tag only has an effect when #labelFontSize is set to auto.

Possible values are:

Value	Description
`0`	There is no space between the edge of the bot and the edge of the label. (Default)
Any Number > 0	The label is sized so that it fits in the space provided by the bot minus the padding.

`labelSize`

The size of the label. Default is 1. Changing this value scales the label text in size without changing the text layout. This is useful for floating labels where you want the bubble to be larger without changing the size of the font.

`labelSizeMode`

The sizing mode for the label.

Possible values are:

Value	Description
`normal`	Don't automatically scale the label size. (default)
`auto`	Automatically scale the label to keep the same size on the screen.

`labelPosition`

The anchor position for the label.

Possible values are:

Value	Description
`top`	Top of the bot facing world oriented up. (default)
`front`	Front of the bot facing world oriented forward.
`back`	Back of the bot facing world oriented back.
`right`	Right of the bot facing world oriented right.
`left`	Left of the bot facing world oriented left.
`floating`	Floating above the bot.

`labelAlignment`

The text alignment for the label.

Possible values are:

Value	Description
`center`	The text is aligned around the center of the face that the label is anchored to. (default)
`left`	The text is aligned on the left side of the face that the label is anchored to.
`right`	The text is aligned on the right side of the face that the label is anchored to.

`labelFontAddress`

The address of the font that the label should use.

If the current font does not support a specific character, the character will be displayed as a crossed out box (i.e. ☒).

Possible values are:

Value	Description
`roboto`	Specifies that the Roboto font should be used. (default)
`noto-sans-kr`	Specifies that the Noto Sans KR font should be used. This is a font with support for the Korean language.
Any URL	Specifies that the font to be used should be downloaded from the given URL. Currently supports WOFF and OTF fonts.

`labelWordWrapMode`

The word wrapping mode that the label should use. Useful for automatically fitting the text onto the bot.

Possible values are:

Value	Description
`breakCharacters`	Line breaks may be inserted inside a word to fit the label on the bot. (default)
`breakWords`	Line breaks may be inserted between words to fit the label on the bot.
none	Line breaks will not be inserted.

`scale`

The uniform scale of the bot.

Defaults to 1.

`scaleX`

The X scale (width) of the bot. Combines with the #scale tag to determine the final width of the bot.

Defaults to 1.

`scaleY`

The Y scale (length) of the bot. Combines with the #scale tag to determine the final length of the bot. For menu bots, you can use auto. This scales the bot's height to fit its label.

Defaults to 1.

`scaleZ`

The Z scale (height) of the bot. Combines with the #scale tag to determine the final height of the bot.

Defaults to 1.

`scaleMode`

How the form is scaled to fit inside the bot.

Note that this setting does not affect #scale, #scaleX, #scaleY or #scaleZ. Instead, it changes how custom forms like meshes are scaled to fit inside the unit cube.

Also note that this setting affects a bot's collision volume. The collision volume will always try to wrap the bot's form to the best of its ability. This means that if you have a really large mesh the collider will scale up to surround the mesh.

Possible values are:

Value	Description
`fit`	The form is scaled to fit inside the bot's unit cube. The aspect ratio will be preserved. (default)
`absolute`	The form is not scaled.

`form`

The shape that the bot should be displayed as.

Possible values are:

Value	Description
`cube`	Cube mesh (default)
`skybox`	A Sphere mesh optimal for "skybox" implementation.
`sphere`	Sphere mesh
`sprite`	Camera facing (billboarded) sprite/quad images.
`mesh`	A mesh loaded from the web. See `#formSubtype` for additional options.
`frustum`	A camera frustum mesh.
`helix`	A double helix mesh (like DNA).
`egg`	A egg mesh.
`hex`	A hexagon mesh.
`circle`	A circle mesh.
`keyboard`	An interactive keyboard. Clicking the keys will generate `@onKeyClick` whispers that are sent to the bot.
`iframe`	A webpage loaded into a 3D iframe. See `#formSubtype` for additional options.
`dimension`	The bot will display the dimension specified by `#formAddress`.
`portal`	The bot will display the dimension specified by `#formAddress`. This is an alias for "dimension".
`spherePortal`	The bot will display the dimension specified by `#formAddress` in a spherical manner, using the X and Y coordinates as latitude and longitude coordinates.
`cursor`	The bot will appear as a cursor in the multi-line editor. You also need to place the bot in the same dimension that the tag portal uses for the cursor to appear.
`codeButton`	The bot will appear as a clickable button in the multi-line editor when placed in the same the same dimension that the tag portal uses. The bot will also need a label in order to appear. The Start position of the bot the line number that the button should appear above, and the End position specifies the priority of the button compared to other buttons on the same line (larger numbers indicate lower priorities). Additionally, it is possible to display code buttons in the multi-line editor's context menu by setting the `#true` tag to `true`. In this case, the `#true` tag represents putting the codeButton in the code editor for every tag.
`codeHint`	The bot will appear as a hint in the multi-line editor when placed in the same the same dimension that the uses. If a `#color` is specified, then the code that the hint covers will use the specified background color. If a `#strokeColor` is specified, then the code that the hint covers will use the stroke as a box border around the code. If given a `#label`, it will be rendered before the start position. Use the `#[dimension]Start` and `#[dimension]End` tags to position the hint. Additionally, codeHint bots support the `@onClick` listener for when their label text is clicked.
`input`	The bot will appear as an input box in the menu portal. You also need to place the bot in the dimension that the menu portal is showing for the input to appear.

`formSubtype`

The subtype that the form should use. Useful for specifying how a mesh should be loaded.

Possible values are:

Value	Description
`null`	No subtype (default)
`gltf`	A GLTF mesh loaded from a URL.
`html`	The HTML code that should be loaded into an iframe when `#form` is set to iframe. (Default when `#form` is set to iframe)
`src`	The URL that should be loaded into an iframe when `#form` is set to iframe.

`formAddress`

The address that the bot should represent data from.

When #form is set to cube, skybox, sphere, or sprite, the address should be the URL of the image that the bot should display.

When #form is set to mesh and #formSubtype is set to gltf, the address should be the URL of the GLTF file that should be displayed.

When #form is set to iframe and #formSubtype is set to html, the address should be the HTML that should be displayed.

When #form is set to iframe and #formSubtype is set to src, the address should be the URL of the webpage that should be displayed.

When the bot is in the menu portal, this is the URL of the image or video that should be shown on the menu item. It can also be cube to show an icon of a cube, egg to show an egg icon, and helix to show an icon of a DNA helix. If the given value is not a URL or one of the predefined icons, then the specified Material Icon will be shown.

`formAddressAspectRatio`

The aspect ratio that should be used to ensure that the image/video from #formAddress is displayed correctly. Aspect ratio is the numerical ratio representing the width of an image divided by the height. For example, a 1080p image has a resolution of 1920x1080 which means it has an aspect ratio of 1920/1080 = 16/9 = ~1.7777777.

By default, CasualOS displays all images with an aspect ratio of 1. An aspect ratio of 1 ensures that the entire bot is covered, but if the original image has a different aspect ratio then it will appear distorted. To solve this, you can use the #formAddressAspectRatio tag to ensure that the aspect ratio that the image is displayed at matches the original aspect ratio.

Also note that negative aspect ratios will mirror the image horizontally.

Currently only supported by the cube, circle, and sprite forms.

Possible values are:

Value	Description
`1`	Square aspect ratio. (default)
Any Number	Custom aspect ratio.

`formAnimation`

The name of the animation that the mesh should play. Only works for mesh forms.

Value	Description
`null`	Play the first animation.
`false`	Stops animating the mesh.
Any String	Play the animation with the given name.
Any Integer >= 0	Play the animation at the given index. Useful for exploring possible animations if you don't have the name.
An array of numbers or strings	Plays the given list of animations in sequence. The last animation will loop forever.

`formAnimationAddress`

The URL that the animations for the mesh should be loaded from. For GLTF forms, this should be the URL of the GLTF file that contains the animations that should be used for the mesh.

Value	Description
`null`	Use the animations that were built into the mesh.
Any URL	Use the animations from the given GLTF file.

`formOpacity`

The opacity of the bot's form. Allows bots to be semi-transparent.

Possible values are:

Value	Description
`1`	(default)
Any Number >= 0 and <= 1	The bot's form will use the given opacity.

`formRenderOrder`

The render order that should be used for this bot in the grid portals. Setting this property to a value other than 0 overrides the automatically calculated render order which is based on the distance of each bot to the portal camera.

It is not recommended to use this tag unless you are dealing with transparency issues caused by overlapping PNG #formAddress images.

Higher values mean the bot will be rendered first, and lower values means the bot will be rendered last.

Possible values are:

Value	Description
`0`	Use the automatic render ordering. (Default)
Any Number	Use the given render ordering. Bots are rendered from the highest value to the lowest value.

`gltfVersion`

The GLTF specification version that should be used to load a GLTF model.

Possible values are:

Value	Description
`2`	Load the GLTF model with version 2 of the specification. (default)
Numbers < 2	Load the GLTF Model with version 1 of the specification. This is useful for loading meshes from poly.google.com.

`progressBar`

Causes a progress bar to be shown for the bot. Range is between 0 and 1. Needs both progressBarBackgroundColor and progressBarColor to visualize the progress

Possible values are:

Value	Description
Numbers >= 0 and <= 1	0 means that you will only see `#progressBarBackgroundColor`. 0.5 means that you will see half of `#progressBarBackgroundColor` and half of `#progressBarColor`. 1 means that you will only see `#progressBarColor`.

`progressBarColor`

The foreground color of the progress bar.

Possible values are:

Value	Description
`black`	(default)
Any X11 Color	X11 colors are a list of standard colors that web browsers support.
Any Hex Color	Hex colors are three or six digit numbers that specify a color by its red, green, and blue components.

`progressBarBackgroundColor`

The background color of the progress bar.

Value	Description
`white`	(default)
Any X11 Color	X11 colors are a list of standard colors that web browsers support.
Any Hex Color	Hex colors are three or six digit numbers that specify a color by its red, green, and blue components.

`progressBarPosition`

The anchor position for the progress bar.

Possible values are:

Value	Description
`top`	Top of the bot facing world oriented up. (default)
`front`	Front of the bot facing world oriented forward.
`back`	Back of the bot facing world oriented back.
`right`	Right of the bot facing world oriented right.
`left`	Left of the bot facing world oriented left.
`floating`	Floating above the bot.

`anchorPoint`

The position that the bot form should rotate and scale around.

Possible values are:

Value	Description
`bottom`	The bot rotates and scales around its bottom point. (default)
`center`	The bot rotates and scales around its center point.
`front`	The bot rotates and scales around the point at the center of the Bot's front face.
`back`	The bot rotates and scales around the point at the center of the Bot's back face.
`top`	The bot rotates and scales around its top point.
`left`	The bot rotates and scales around the point at the center of the Bot's left face.
`right`	The bot rotates and scales around the point at the center of the Bot's right face.
`[x,y,z]`	The bot rotates and scales around the specified point. Should be an array of 3 numbers representing X, Y, and Z respectively. Numbers between 0.5 and -0.5 map to the edges of the bot.
Any 3D Vector	The bot rotates and scales around the specified point. Should be a 3D bot vector representing X, Y, and Z respectively. Numbers between 0.5 and -0.5 map to the edges of the bot.

`orientationMode`

The mode that determines how the bot automatically rotates.

Possible values are:

Value	Description
`absolute`	The bot does not rotate automatically. (default)
`billboard`	The bot rotates left, right, up, and down automatically to point its top face towards the player.
`billboardTop`	The bot rotates left and right automatically to point its top face towards the player.
`billboardFront`	The bot rotates left and right automatically to point its front face towards the player.

`maxLODThreshold`

The minimum percentage of the screen that the bot form should take up in order to enter the maximum Level-Of-Detail. When the maximum LOD is entered the @onMaxLODEnter listener is triggered. When the maximum LOD is exited the @onMaxLODExit listener is triggered.

Value	Description
`0.03`	The bot enters the maximum LOD when it takes up 3% of the screen space. (default)
Numbers > 0 and < 1	The bot enters the maximum LOD when it takes up more screen space than the value.

`minLODThreshold`

The maximum percentage of the screen that the bot form should take up in order to enter the minimum Level-Of-Detail. When the minimum LOD is entered the @onMinLODEnter listener is triggered. When the minimum LOD is exited the @onMinLODExit listener is triggered.

Value	Description
`0.0005`	The bot enters the minimum LOD when it takes up 0.05% of the screen space. (default)
Numbers > 0 and < 1	The bot enters the minimum LOD when it takes up less screen space than the value.

`transformer`

The ID of the bot that should transform this bot in the bot and miniGridPortals. When the transformer bot and this bot are in the same dimension, this bot will inherit the position and rotation of the transformer bot.

When set on a portal bot (like gridPortalBot), this will transform the portal camera by the specified bot.

Value	Description
`null`	The bot is positioned on the grid. (default)
Any String	The bot is positioned on the bot with the given ID.

`menuItemStyle`

The custom CSS styles that should be applied to the menu item. Only applies to bots that are being shown in the menu portal.

This is useful for positioning and styling the item in ways that are not possible using normal tags. Overridden by conflicting properties like #color or #labelColor.

When setting this tag via the sheet, it is useful to utilize DNA tags to ensure that the resulting value is considered an object.

Possible values are:

Value	Description
`null`	No special styling. (Default)
Any Object	The properties of the object will be applied as special styling to the menu item.

Examples:

Round the top corners of the menu bot.

🧬{
    "border-radius": "8px 8px 0 0",
    "margin-top": "8px"
}

`menuItemLabelStyle`

The custom CSS styles that should be applied to the menu item label. Only applies to bots that are being shown in the menu portal.

This is useful for styling the label in ways that are not possible using normal tags. Overrides conflicting properties like #color or #labelColor.

When setting this tag via the sheet, it is useful to utilize DNA tags to ensure that the resulting value is considered an object.

Note: when using a larger font size you may also need to increase the line-height. The default line-height is "24px".

Possible values are:

Value	Description
`null`	No special styling. (Default)
Any Object	The properties of the object will be applied as special styling to the menu item.

Examples:

Use custom font settings on the menu bot label.

🧬{
    "font-size": "36px",
    "line-height": "36px",
    "font-weight": "bold"
}

`menuItemHoverMode`

The mode that menu items should use when the cursor hovers over the bot when it is in the menu portal. Currently only affects menu bots that are buttons (input bots are not hoverable).

Note that this only determines how the menu item looks when the mouse pointer hovers over the item. It does not affect the @onClick, @onPointerEnter, @onPointerExit, etc. listeners.

Possible values are:

Value	Description
`auto`	The bot will appear hoverable if it has a `@onClick` tag. (Default)
`hover`	The bot will appear hoverable.
`none`	The bot will not appear hoverable.

`menuItemText`

The text that has been entered in the menu item's input box. Only has an effect on menu items that have #form set to input.

This tag will also be updated in the tempLocal space when the user types in the input box.

Possible values are:

Value	Description
`null`	No text in the input box. (Default)
`false`	No text in the input box. CasualOS will use this when the user has deleted all the text from the input box and there is a non-null value in the menuItemText tag.
Any String	The text will appear in the input box.

`menuItemShowSubmitWhenEmpty`

Whether to show the submit button on input menu items even if the input box is empty. Only has an effect on menu items that have #form set to input.

Possible values are:

Value	Description
`false`	The submit button will only show when the input box is not empty. (Default)
`true`	The submit button will always show.

Dimension Tags

`[dimension]`

Add a bot to a dimension.

Example: Set #room1 to true for the bot to appear in a dimension named room1.

Possible values are:

Value	Description
`false`	Removes the bot from the dimension. (default)
`true`	Puts the bot into the dimension.

`[dimension]SortOrder`

The order that the bot should be in a stack of bots.

When bots are stacked, they are placed from the bottom to the top based on the sort order. So a bot with a sort order of 1 is going to be placed on top of a bot with a sort order of 2.

Possible values are:

Value	Description
Any Number	Specifies the sort order of a bot in a stack of bots. (Default is 0)

`[dimension]Position`

The vector position of a bot on the grid in the specified dimension. Must be a vector type. If not specified or the value is not a vector, then #[dimension]X, #[dimension]Y, and #[dimension]Z will be used.

Integer values are mapped directly to the grid. e.g. 1.5 means halfway between the 1 and 2 grid squares.

Possible values are:

Value	Description
`➡️0,0,0`	The bot will be placed in the center of the grid. (Default)
Any Vector	Specifies the X, Y, and Z position of a bot in a dimension.

Examples

Place this bot at (1, 2, 3) in the home dimension.
tags.homePosition = new Vector3(1, 2, 3);

Toast the position of this bot in the home dimension.
const homePosition = getBotPosition(thisBot, 'home');
os.toast('home Position: ' + homePosition);

`[dimension]X`

The X (east-west) position of a bot on the grid in the specified dimension.

Integer values are mapped directly to the grid. e.g. 1.5 means halfway between the 1 and 2 grid squares.

Possible values are:

Value	Description
Any Number	Specifies the X position of a bot in a dimension. (Default is 0)

`[dimension]Y`

The Y (north-south) position of a bot on the grid in the specified dimension.

Integer values are mapped directly to the grid. e.g. 1.5 means halfway between the 1 and 2 grid squares.

Possible values are:

Value	Description
Any Number	Specifies the Y position of a bot in a dimension. (Default is 0)

`[dimension]Z`

The Z (up-down) offset that the bot is offset above/below the grid.

Possible values are:

Value	Description
Any Number	Specifies the Z position of a bot in a dimension. (Default is 0)

`[dimension]Rotation`

The rotation in that the bot should be oriented by in the specified dimension. Must be a rotation type. If not specified or the value is not a rotation, then #[dimension]RotationX, #[dimension]RotationY, and #[dimension]RotationZ will be used.

Possible values are:

Value	Description
`🔁0,0,0,1`	The bot will be placed flat on the grid. (Default)
Any Rotation	Specifies the rotation of a bot in a dimension.

Examples:

Rotate this bot by 90 degrees around the X axis in the home dimension
tags.homeRotation = new Rotation({
    axis: new Vector3(1, 0, 0),
    angle: Math.PI / 2
});

Toast the rotation of this bot in the home dimension
const homeRotation = getBotRotation(thisBot, 'home');
os.toast('home Rotation: ' + homeRotation);

Possible values are:

Value	Description
Any Number	Specifies the X rotation of a bot in a dimension. (Default is 0)

`[dimension]RotationX`

The X (pitch) rotation in radians that the bot should be rotated by.

Possible values are:

Value	Description
Any Number	Specifies the X rotation of a bot in a dimension. (Default is 0)

`[dimension]RotationY`

The Y (roll) rotation in radians that the bot should be rotated by.

Possible values are:

Value	Description
Any Number	Specifies the Y rotation of a bot in a dimension. (Default is 0)

`[dimension]RotationZ`

The Z (yaw) rotation in radians that the bot should be rotated by.

Possible values are:

Value	Description
Any Number	Specifies the Z rotation of a bot in a dimension. (Default is 0)

`[dimension]Start`

The start value for bots that are in the multi-line editor (tag portal/sheet portal).

For cursor bots, this value indicates the character index that selection starts at.

For codeButton bots, this value indicates the line number that the button should appear above.

For codeHint bots, this value can indicate the character index that the hint starts at. Alternatively, it can indicate the line and column numbers that the hint starts at.

Possible values are:

Value	Description
Any Number	Specifies the value at which the bot starts in the dimension. (Default is 0)
Any Vector	Specifies the line (x component) and column (y component) that the hint starts at. Only applicable to codeHint bots.

`[dimension]End`

The end value for bots that are in the multi-line editor (tag portal/sheet portal).

For cursor bots, this value indicates the character index that the selection stops at.

The codeButton bots, this value indicates the priority for the button. Priority determines the order that buttons on the same line are shown in. (Higher numbers means lower priority)

For codeHint bots, this value can indicate the character index that the hint end at. Alternatively, it can indicate the line and column numbers that the hint end at.

Possible values are:

Value	Description
Any Number	Specifies the index at which the bot ends in the dimension. (Default is 0)
Any Vector	Specifies the line (x component) and column (y component) that the hint ends at. Only applicable to codeHint bots.

Portal Bot Tags

These tags are used to configure portals. They can be set on the corresponding portal bot.

Some of them are automatically set by the corresponding portal but most of them (like the cameraPositionOffset tags) can be changed manually.

`portalColor`

The color of the background of the portal.

Possible values are:

Value	Description
`#263238`	(default)
Any X11 Color	X11 colors are a list of standard colors that web browsers support.
Any Hex Color	Hex colors are three or six digit numbers that specify a color by its red, green, and blue components.

`portalCursor`

The cursor that should be used when the mouse is hovered over the portal. The portal cursor is overriden when a bot with a #cursor tag is hovered.

Note that when using a custom cursor image, the image should be 32x32 pixels or smaller. This is because that is the largest cursor image size that some operating systems support.

Possible values are:

Value	Description
`auto`	The cursor automatically changes its look based on the context. For grid portal bots, this means that the arrow cursor is used. For menu portal bots, this means that the pointer is used when the bot has a `@onClick` and the arrow is used otherwise. (default)
`default`	The cursor looks like the default cursor for the platform. Generally, this means the arrow cursor.
`none`	The cursor is invisible.
`wait`	wait
`context-menu`	context-menu
`help`	help
`pointer`	pointer
`progress`	progress
`cell`	cell
`crosshair`	crosshair
`text`	text
`vertical-text`	vertical-text
`alias`	alias
`copy`	copy
`move`	move
`no-drop`	no-drop
`not-allowed`	not-allowed
`grab`	grab
`grabbing`	grabbing
`all-scroll`	all-scroll
`col-resize`	col-resize
`row-resize`	row-resize
`n-resize`	n-resize
`e-resize`	e-resize
`s-resize`	s-resize
`w-resize`	w-resize
`ne-resize`	ne-resize
`nw-resize`	nw-resize
`se-resize`	se-resize
`sw-resize`	sw-resize
`ew-resize`	ew-resize
`ns-resize`	ns-resize
`nesw-resize`	nesw-resize
`nwse-resize`	nwse-resize
`zoom-in`	zoom-in
`zoom-out`	zoom-out
Any URL	The image at the given URL will be used as the cursor. Images should be 32x32 pixels or smaller otherwise they may not work.

`portalCursorHotspot`

The X position of the pixel in the cursor image that is the "hotspot". That is, the pixel which represents the point or tip of the cursor.

The top left of the image is (0, 0).

Possible values are:

Value	Description
`➡️0,0`	(default)
Any Vector > ➡️0,0	The position that the cursor hotspot should be at.

`portalBackgroundAddress`

The URL of the image or video that should be displayed as the background of the portal.

When specified, this tag overrides ##portalColor. Additionally, this tag does nothing when in VR.

Possible values are:

Value	Description
`null`	(default)
Any URL	Specifies that the portal background should use the given image or video.
`"casualos://camera-feed"`	Display a feed of the main camera as the background.
`"casualos://camera-feed/rear"`	Display a feed of the rear (environment) facing camera as the background.
`"casualos://camera-feed/front"`	Display a feed of the front (user) facing camera as the background.

`portalLocked`

Determines if the portal can be loaded.

Possible values are:

Value	Description
`true`	The portal can be loaded. (Default)
`false`	The portal cannot be loaded.

`portalPannable`

Whether the player will be able to pan the camera inside the portal.

Possible values are:

Value	Description
`true`	The camera is pannable in this portal. (Default)
`false`	The camera is not pannable in this portal.

`portalPannableMin`

The minimum values that the camera can pan to in the portal.

See the documentation on Vectors for more info.

Possible values are:

Value	Description
Any Vector	Minimum X and Y values that the camera can pan to. (Default is Negative Infinity)

`portalPannableMax`

The maximum X and Y values that the camera can pan to in the portal.

See the documentation on Vectors for more info.

Possible values are:

Value	Description
Any Vector	Maximum X and Y values that the camera can pan to. (Default is Infinity)

`portalRotatable`

ExamplegridPortalBot miniGridPortalBot

Whether the player will be able to rotate the camera inside the miniGridPortal.

Possible values are:

Value	Description
`true`	The miniGridPortal is rotatable. (Default)
`false`	The miniGridPortal is not rotatable.

`portalCameraRotation`

The up and down rotation that the camera starts at in the portal. Units are in radians.

Because the bot and miniGridPortals use polar coordinates to orbit around the focus point, we only need two numbers to specify where the camera should be pointing. Polar coordinates work by specifying two angles (X and Y - also known as "phi" and "theta") which position the camera around its focus point. Therefore, these rotation values actually cause the camera to turn around the focus point and not simply turn the camera itself.

The X angle (phi) is used to rotate the camera up and down. Mathematically, a value of 0 means the camera is facing directly down and a value of π / 2 means the camera is perfectly parallel with the ground. For usability reasons, CasualOS limits this value to between 0 and 58 degrees (~1.01229 radians).

The Y angle (theta) is used to rotate the camera left and right. Mathematically, a value of 0 means the camera is facing the front face of bots and a value of π / 2 means the camera is facing the left face of the bots.

See the documentation on Vectors for more info.

Possible values are:

Value	Description
Any Vector	The X and Y rotation values that should be used for the initial camera rotation. Units are in radians.

`portalZoomable`

gridPortalBot miniGridPortalBot mapPortalBot miniMapPortalBot

Whether the player will be able to zoom the camera inside the portal.

Possible values are:

Value	Description
`true`	The camera is zoomable in this portal. (Default)
`false`	The camera is not zoomable in this portal.

`portalZoomableMin`

The minimum value that the camera can zoom to in the portal. Does not affect VR/AR sessions. For the mapPortal and miniMapPortal, the value is measured in meters.

Possible values are:

Value	Description
Any Number > 0	Minimum value that the camera zoom to. (Default is 0.4 for the grid portals and -Infinity for the map portals)

`portalZoomableMax`

gridPortalBot miniGridPortalBot mapPortalBot miniMapPortalBot

The maximum value that the camera can zoom to in the portal. Does not affect VR/AR sessions. For the mapPortal and miniMapPortal, the value is measured in meters.

Possible values are:

Value	Description
Any Number > 0	Maximum value that the camera can zoom to. (Default is 80 for the grid portals and EARTH_RADIUS * 4 for the map portals)

`portalCameraZoom`

The zoom value that the camera starts at in the portal.

Possible values are:

Value	Description
Any Number > 0	The initial zoom value. (Default is 1)

`portalGridScale`

The size of bots in the portal.

Possible values are:

Value	Description
Any Number > 0	The size of bots in the portal. (Default is 0.025 for wrist portals and 0.2 for all other portals)

`portalSurfaceScale`

The scale of surfaces.

Possible values are:

Value	Description
Any Number > 0	The scale of surface for the dimension. (Default is 2)

`portalCameraControls`

The mode that specifies how the camera controls work in the portal.

Possible values are:

Value	Description
`"player"`	Specifies that the player should be able to control the camera. Individual options like `#portalZoomable` override this option.
`false`	Specifies that the player should not be able to control the camera in the portal.

`portalShowFocusPoint`

miniGridPortalBot miniGridPortalBot

Whether the focus point of the portal camera should be shown as a small sphere.

The focus point is the position that the camera orbits (rotates) around and is always facing.

When a bot is between the focus point and the camera, then focus events will trigger.

Possible values are:

Value	Description
`false`	Don't show an indicator for the focus point. (Default)
`true`	Show an indicator for the focus point.

`portalCameraType`

gridPortalBot

The type of camera that should be used for the portal. The "type" of a camera determines how objects are visualized and how they appear. Conceptually, camera types are similar to camera lenses.

Possible values are:

Value	Description
`orthographic`	The camera uses an orthographic projection. This camera type preserves parallel lines so lines that are parallel to each other will remain parallel in the 2D image. As a consequence, objects that are the same size always appear the same size no matter how far away they are from the camera. (Default)
`perspective`	The camera uses a perspective projection. This camera type makes objects appear larger or smaller based on how far away they are from the camera.

`portalDisableCanvasTransparency`

gridPortalBot

Whether to disable transparency on the canvas element that the 3D content is displayed on.

Set this tag to true on the grid portal to fix rendering issues with 3D models that use alpha cutoff. Note that when this value is true, iframe forms will cease to function properly.

Possible values are:

Value	Description
`false`	The canvas element is transparent to support iframe forms. (Default)
`true`	The canvas element is not transparent 3D models that use alpha cutoff.

`miniPortalHeight`

Sets the initial height of the viewport for the miniGridPortal/miniMapPortal.

This should be the percentage of the "available screen height" that the miniGridPortal/miniMapPortal should take. The "available screen height" is a portion of the full screen calculated such that when there is some space left between the left and right edges of the screen there will be some space at the bottom of the portal. However, when the #miniPortalWidth tag is set to 1, there will be no space between the bottom of the screen and the bottom of the portal.

Possible values are:

Value	Description
Numbers >= 0 and <= 1	The percentage of the screen height that the portal should take. (Default is 0.2)

`miniPortalWidth`

miniGridPortalBot miniMapPortalBot

Sets the width of the viewport for the miniGridPortal/miniMapPortal. This should be a percentage between 0 and 1 that specifies how much of the screen width should be taken.

Possible values are:

Value	Description
Numbers >= 0 and <= 1	The percentage of the screen width that the portal should take. (Default is 0.8)

`miniPortalResizable`

miniGridPortalBot miniMapPortalBot

Whether the player will be able to resize the viewport for the miniGridPortal/miniMapPortal.

Possible values are:

Value	Description
`true`	The portal is resizable. (Default)
`false`	The portal is not resizable.

`mapPortalBasemap`

mapPortalBot miniMapPortalBot

Sets the style of the bottom layer of the map in the mapPortal/miniMapPortal.

Possible values are:

Value	Description
`dark-gray`	(Default)
Any Basemap	See this for a full list.

`wristPortalHeight`

leftWristPortalBot rightWristPortalBot

The number of grid spaces that the wrist portal should have in the Y direction.

Possible values are:

Value	Description
Numbers >= 1	The number of of grid spaces that the portal should have in the Y direction. (Default is 6)

`wristPortalWidth`

leftWristPortalBot rightWristPortalBot

The number of grid spaces that the wrist portal should have in the X direction.

Possible values are:

Value	Description
Numbers >= 1	The number of of grid spaces that the portal should have in the X direction. (Default is 6)

`meetPortalVisible`

Whether the meet portal should be visible. This is useful for hiding the meet portal while still in a meeting.

Possible values are:

Value	Description
`true`	The meet portal will be visible. (Default)
`false`	The meet portal will be hidden.

`meetPortalAnchorPoint`

The position on the screen that the meet portal should be anchored to. Overrides any conflicting properties set by #meetPortalStyle.

Possible values are:

Value	Description
`fullscreen`	The meet portal will occupy the entire screen. (Default)
`top`	The meet portal will occupy the top of the screen.
`topRight`	The meet portal will occupy the top-right corner of the screen.
`topLeft`	The meet portal will occupy the top-left corner of the screen.
`bottom`	The meet portal will occupy the bottom of the screen.
`bottomRight`	The meet portal will occupy the bottom-right corner of the screen.
`bottomLeft`	The meet portal will occupy the bottom-left corner of the screen.
`left`	The meet portal will occupy the left side of the screen.
`right`	The meet portal will occupy the right side of the screen.
`[top, right, bottom, left]`	The meet portal will use the given values for the CSS top, right, left, and bottom properties of the container.

`meetPortalStyle`

The custom CSS styles that should be applied to the meet portal container. This is useful for positioning the meet portal in ways that are not possible using #meetPortalAnchorPoint. Overridden by conflicting properties set by #meetPortalAnchorPoint.

When setting this tag via the sheet, it is useful to utilize DNA tags to ensure that the resulting value is considered an object.

Possible values are:

Value	Description
`null`	No special styling. (Default)
Any Object	The properties of the object will be applied as special styling to the meet portal container.

Examples

Put the meet portal in the center of the screen.

🧬{
    "top": "10%",
    "bottom": "10%",
    "left": "10%",
    "right": "10%",
}

`meetPortalPrejoinEnabled`

Whether the meet portal should have the prejoin screen enabled. The prejoin screen is where the user can setup their display name, microphone, camera, and other settings, before actually joining the meet.

Possible values are:

Value	Description
`true`	The prejoin screen is enabled. (Default)
`false`	The prejoin screen is disabled.

`meetPortalStartWithVideoMuted`

Whether the meet portal should start with video muted. Video in this context is equivalent to the user's camera.

Possible values are:

Value	Description
`true`	The meet portal starts with video muted. (Default)
`false`	The meet portal starts with video unmuted.

`meetPortalStartWithAudioMuted`

Whether the meet portal should start with audio muted. Audio in this context is equivalent to the user's microphone.

Possible values are:

Value	Description
`true`	The meet portal starts with audio muted.
`false`	The meet portal starts with audio unmuted. (Default)

`meetPortalRequireDisplayName`

Whether the meet portal should require the user define a display name.

Possible values are:

Value	Description
`true`	The meet portal requires a user display name. (Default)
`false`	The meet portal does not require a user display name.

`meetPortalDisablePrivateMessages`

Whether the meet portal should hide the option to send private chat messages to other participants.

Possible values are:

Value	Description
`false`	The meet portal allows sending private messages to other participants. (Default)
`true`	The meet portal hides the option to start a new private message chat with another participant. Replies to private messages are still allowed.

`meetPortalLanguage`

The language that should be used for the meet portal interface by default. Only works if this tag is set before the meet portal is loaded.

Possible Values are:

Value	Description
`null`	The user-configured value will be used for the meetPortal interface. (Default)
Any ISO 639-1 Code	The interface will use the given ISO 639-1 language code. Note that not all langauge codes are supported. The full list of supported translations can be found here.

`meetPortalJWT`

The JSON Web Token (JWT) that should be used to join the meeting. Used to give the current user moderator permissions.

Possible Values are:

Value	Description
`null`	The user will be a normal user in the meet portal. (Default)
Any String	The user will use the JWT for authentication in the meet portal. Depending on the settings used to create the JWT, this may make the user a moderator.

`botPortalAnchorPoint`

botPortalBot

The position on the screen that the bot portal should be anchored to. Overrides any conflicting properties set by #botPortalStyle

Possible values are:

Value	Description
`fullscreen`	The bot portal will occupy the entire screen. (Default)
`top`	The bot portal will occupy the top of the screen.
`topRight`	The bot portal will occupy the top-right corner of the screen.
`topLeft`	The bot portal will occupy the top-left corner of the screen.
`bottom`	The bot portal will occupy the bottom of the screen.
`bottomRight`	The bot portal will occupy the bottom-right corner of the screen.
`bottomLeft`	The bot portal will occupy the bottom-left corner of the screen.
`left`	The bot portal will occupy the left side of the screen.
`right`	The bot portal will occupy the right side of the screen.
`[top, right, bottom, left]`	The bot portal will use the given values for the CSS top, right, left, and bottom properties of the container.

`botPortalStyle`

botPortalBot

The custom CSS styles that should be applied to the bot portal container. This is useful for positioning the tag portal in ways that are not possible using #botPortalAnchorPoint. Overridden by conflicting properties set by #botPortalAnchorPoint.

When setting this tag via the sheet, it is useful to utilize DNA tags to ensure that the resulting value is considered an object.

Possible values are:

Value	Description
`null`	No special styling. (Default)
Any Object	The properties of the object will be applied as special styling to the bot portal container.

Examples

Put the bot portal in the center of the screen.

🧬{
    "top": "10%",
    "bottom": "10%",
    "left": "10%",
    "right": "10%",
}

`tagPortalAnchorPoint`

The position on the screen that the tag portal should be anchored to. Overrides any conflicting properties set by #tagPortalStyle.

Possible values are:

Value	Description
`fullscreen`	The tag portal will occupy the entire screen. (Default)
`top`	The tag portal will occupy the top of the screen.
`topRight`	The tag portal will occupy the top-right corner of the screen.
`topLeft`	The tag portal will occupy the top-left corner of the screen.
`bottom`	The tag portal will occupy the bottom of the screen.
`bottomRight`	The tag portal will occupy the bottom-right corner of the screen.
`bottomLeft`	The tag portal will occupy the bottom-left corner of the screen.
`left`	The tag portal will occupy the left side of the screen.
`right`	The tag portal will occupy the right side of the screen.
`[top, right, bottom, left]`	The tag portal will use the given values for the CSS top, right, left, and bottom properties of the container.

`tagPortalStyle`

The custom CSS styles that should be applied to the tag portal container. This is useful for positioning the tag portal in ways that are not possible using #tagPortalAnchorPoint. Overridden by conflicting properties set by #tagPortalAnchorPoint.

When setting this tag via the sheet, it is useful to utilize DNA tags to ensure that the resulting value is considered an object.

Possible values are:

Value	Description
`null`	No special styling. (Default)
Any Object	The properties of the object will be applied as special styling to the tag portal container.

Examples

Put the tag portal in the center of the screen.

🧬{
    "top": "10%",
    "bottom": "10%",
    "left": "10%",
    "right": "10%",
}

`tagPortalShowButton`

Whether the tag portal should show a button that allows a custom action. When set to true, the button will be displayed in the lower right hand corner of the tag portal.

Clicking the button will trigger a @onClick on the tag portal config bot.

Possible values are:

Value	Description
`false`	No button is shown. (Default)
`true`	The button is shown.

`tagPortalButtonIcon`

The Material Icon that should be shown on the tag portal button.

Possible values are:

Value	Description
Empty String	No icon. (Default)
Any Material Icon	See https://material.io/resources/icons/?style=baseline.

`tagPortalButtonHint`

The tooltip that should be shown on the tag portal button.

Possible values are:

Value	Description
Empty String	No hint. (Default)
Any String	The text that should be displayed as a hint when the user hovers their mouse over the button.

`menuPortalStyle`

ExamplemenuPortalBot

The custom CSS styles that should be applied to the menu portal container. This is useful for positioning the menu portal in ways that are not possible normally.

When setting this tag via the sheet, it is useful to utilize DNA tags to ensure that the resulting value is considered an object.

Possible values are:

Value	Description
`null`	No special styling. (Default)
Any Object	The properties of the object will be applied as special styling to the menu portal container.

Examples

Make the menu portal 80% of the screen width.

🧬{
    "width": "80%",
}

`sheetPortalShowButton`

Whether the sheet portal should show a button that allows a custom action. When set to true, the button will be displayed in the lower right hand corner of the sheet portal.

Clicking the button will trigger a @onClick on the sheet portal config bot. If there is no @onClick, then the sheet portal will be closed.

Possible values are:

Value	Description
`true`	The button is shown. (Default)
`false`	No button is shown.

`sheetPortalButtonIcon`

The Material Icon that should be shown on the sheet portal button.

Possible values are:

Value	Description
web_asset	The Web Asset icon. (Default)
Any Material Icon	See https://material.io/resources/icons/?style=baseline.

`sheetPortalButtonHint`

The tooltip that should be shown on the sheet portal button.

Possible values are:

Value	Description
`Grid Portal`	"Grid Portal" (Default)
Any String	The text that should be displayed as a hint when the user hovers their mouse over the button.

`sheetPortalAllowedTags`

The list of tags that should be allowed in the sheet portal.

Possible values are:

Value	Description
`null`	All tags are allowed. (Default)
Any Array	Only the specified tags can be shown in the sheet portal.

`sheetPortalAddedTags`

The list of tags that should be shown in the sheet even if they do not have a value.

Possible values are:

Value	Description
`null`	No additional tags are shown. (Default)
Any Array	The specified tags are shown in the sheet portal.

`pixelWidth`

AutomaticgridPortalBot

The width of the grid portal in pixels. Because the miniGridPortal is contained by the grid portal, this value also applies to the miniGridPortal.

Note that a device with a larger pixel value is not necessarily physically larger than a device with a smaller pixel value. Additionally, a device with a larger width than height does not necessarily mean that it is in landscape mode.

Finally, #pixelHeight and #pixelWidth use CSS pixels which are dependent on the #defaultPixelRatio specified by the web browser. You can find the physical pixel width of the device by calculating pixelWidth * defaultPixelRatio.

`pixelHeight`

AutomaticgridPortalBot

The height of the grid portal in pixels. Because the miniGridPortal is contained by the grid portal, this value also applies to the miniGridPortal.

Note that a device with a larger pixel value is not necessarily physically larger than a device with a smaller pixel value. Additionally, a device with a larger height than width does not necessarily mean that it is in portrait mode.

`pixelRatio`

Config Bot

The pixel ratio that should be used to determine how many physical pixels should be used to draw each pixel in the 3D portals. Higher values will make the 3D portals appear smoother but will also cause CausalOS to run slower.

Possible values are:

Value	Description
`null`	Use the default pixel ratio. (Default)
Any Number > 0	The pixel ratio that should be used.

`defaultPixelRatio`

AutomaticConfig Bot

The pixel ratio that is used when the #pixelRatio tag is not set. This value is determined by the web browser and cannot be changed. High resolution/Retina displays tend to have a pixel ratio of 2 or higher while devices with lower resolution displays tend to have a pixel ratio of 1.

`pointerPixel`

AutomaticgridPortalBot

The X and Y position (location along width) of the pointer (usually mouse, but can also be the position of the first finger to touch the screen) in the grid portal in pixels.

Larger X values are closer to the right of the screen and lower values are closer to the left part of the screen.

Larger Y values are closer to the bottom of the screen and lower values are closer to the top part of the screen.

`cameraPosition`

The 3D position of the player's camera in the grid portal.

See the documentation on Vectors for more info.

`cameraPositionOffset`

The offset that should be applied to the 3D position of the player's camera in the grid portal.

Useful for moving the player around in VR.

See the documentation on Vectors for more info.

`cameraRotation`

The 3D rotation of the player's camera in the grid portal.

Units are in radians.

See the documentation on Rotations for more info.

`cameraRotationOffset`

The offset that should be applied to the 3D rotation of the player's camera in the grid portal.

Units are in radians.

See the documentation on Rotations for more info.

`cameraZoom`

The zoom value that the camera is at. This is an arbitrary value that specifies how far the camera is zoomed in or out.

Larger values indicate that the camera is zoomed in more (objects appear bigger) and smaller values indicate that the camera is zoomed out (objects appear smaller).

`cameraZoomOffset`

The offset that should be applied to the camera zoom. You can use this to change the zoom of the camera.

Larger values indicate that the camera is zoomed in more (objects appear bigger) and smaller values indicate that the camera is zoomed out (objects appear smaller).

`cameraFocus`