dot big bang

Developer API
Menu

Namespace Utility

All
  • Public
  • Public/Protected
  • All

Index

Classes

Type aliases

Variables

Type aliases

AnyObject

AnyObject: {}

An object that could have any property, and that property could have any value.

This can be used instead of any in places where you want to distinguish the object from null, since any | null doesn't require null due to how the any type works in TypeScript.

Type declaration

  • [key: string]: any

JSONSerializable

JSONSerializable: string | number | boolean | null | JSONSerializable[] | {}

A utility type that represents any value which can be represented in JSON, namely:

  • strings
  • numbers
  • booleans
  • null
  • Arrays/Objects containing the above, potentially nested

It may be useful to use this type when sending events, when sending messages over the network, or when working with SaveData.

Variables

Const Debug

Debug: { drawLine: any; drawLineNoDepth: any }

Type declaration

  • drawLine: function
    • Draw a debug line from start to finish with depth testing

      Parameters

      • start: Vector3
      • end: Vector3
      • Optional color: Color

        The color of the line. The default value is White

      • Optional lifetimeSeconds: number

        How long the line will be visible for in seconds. 0 means it is only visible for the current frame. The default value is 0

      Returns void

  • drawLineNoDepth: function
    • Draw a debug line from start to finish without depth testing

      Parameters

      • start: Vector3
      • end: Vector3
      • Optional color: Color

        The color of the line. The default value is White

      • Optional lifetimeSeconds: number

        How long the line will be visible for in seconds. 0 means it is only visible for the current frame. The default value is 0

      Returns void