Camera Types

• CameraType

  The possible camera types.

  A CameraType can be one of the following values:

  • "front"
  • "rear"

• FocusOnOptions

  Options for os.focusOn(bot, options), and os.focusOn(position, options) actions.

  Members

  • columnNumber? number

    The column number that should be selected in the editor. Only supported in the system portal, sheet portal, and tag portals.

  • duration? number

    The duration in seconds that the animation should take. Defaults to 1.

  • easing? (Easing | EaseType)

    The options for easing. Can be an "easing type" or an object that specifies the type and mode. If an easing type is specified, then "inout" mode is used. If omitted, then "quadratic" "inout" is used.

  • endIndex? number

    The index of the last character that should be selected. Only supported in the system portal, sheet portal, and tag portals.

  • lineNumber? number

    The line number that should be selected in the editor. Only supported in the system portal, sheet portal, and tag portals.

  • portal? string

    The portal that the bot should be focused in. If not specified, then the bot will be focused in all the portals it is in. (bot, mini and menu) Useful if a bot is in two portals but you only want to focus it in one portal.

  • rotation? FocusOnRotation

  • space? string

    The tag space that should be focused. Only supported in the system portal, sheet portal, and tag portals.

  • startIndex? number

    The index of the first character that should be selected. Only supported in the system portal, sheet portal, and tag portals.

  • tag? string

    The tag that should be focused. Only supported in the system portal.

  • zoom? number

• FocusOnRotation

  Defines an interface that represents a rotation in polar coordinates for use with os.focusOn(bot, options).

  Members

  • normalize? boolean

    Whether to normalize the rotation. Normalized rotations are clamped to between 0 and Math.PI2. You can set this to false to allow using angles more than Math.PI2. This would allow the camera to rotate around an object multiple times. Defaults to true.

  • x number

  • y number