Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace common

Index

Functions

Functions

Const acosh

  • acosh(arg: number): number

Const angleBetweenPositions

  • angleBetweenPositions(x1: number, y1: number, x2: number, y2: number): number

  • Returns the angle, in degrees, between two positions.

    Parameters

    • x1: number

      First point X position.

    • y1: number

      First point Y position.

    • x2: number

      Second point X position.

    • y2: number

      Second point Y position.

    Returns number

    The angle between the positions, in degrees.

Const angleDifference

  • angleDifference(angle1: number, angle2: number): number

  • Returns the difference between two angles, in degrees.

    Parameters

    • angle1: number

      First angle, in degrees.

    • angle2: number

      Second angle, in degrees.

    Returns number

    Return the difference of the angles, in degrees.

Const asinh

  • asinh(arg: number): number

Const atanh

  • atanh(arg: number): number

Const cbrt

  • cbrt(x: number): number

Const ceilTo

  • ceilTo(value: number, decimalPlace: number): number

Const clamp

  • clamp(x: number, min: number, max: number): number

Const cosh

  • cosh(arg: number): number

Const cot

  • cot(arg: number): number

Const csc

  • csc(arg: number): number

Const distanceBetweenPositions

  • distanceBetweenPositions(x1: number, y1: number, x2: number, y2: number): number

  • Returns the distance, in pixels, between two positions.

    Parameters

    • x1: number

      First point X position.

    • y1: number

      First point Y position.

    • x2: number

      Second point X position.

    • y2: number

      Second point Y position.

    Returns number

    The distance between the positions, in pixels.

Const exponentialInterpolation

  • exponentialInterpolation(start: number, end: number, progress: number): number

  • Return an exponential interpolation between start and end.

    For instance, exponentialInterpolation(2, 8, 0.5) is 4.

    Parameters

    • start: number

      Start value.

    • end: number

      End value.

    • progress: number

      The interpolation value between 0 and 1.

    Returns number

    The interpolated value.

Const floorTo

  • floorTo(value: number, decimalPlace: number): number

Const getVariableBoolean

  • getVariableBoolean(variable: Variable, compareWith: boolean): boolean

Const getVariableChildCount

  • getVariableChildCount(variable: Variable): number

Const getVariableNumber

  • getVariableNumber(variable: Variable): number

Const getVariableString

  • getVariableString(variable: Variable): string

Const getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

  • Compute the X position when given an angle and distance relative to the origin (0;0). This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels.

    Returns number

Const getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

  • Compute the Y position when given an angle and distance relative to the origin (0;0). This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels.

    Returns number

Const globalVariableExists

Const isMobile

  • isMobile(): boolean

  • Check if the game runs on a mobile device (iPhone, iPad, Android). Note that the distinction between what is a mobile device and what is not is becoming blurry. If you use this for mobile controls, prefer to check if the device has touchscreen support.

    Returns boolean

Const lerp

  • lerp(a: number, b: number, x: number): number

  • Return a linear interpolation between a and b.

    For instance, lerp(2, 8, 0.5) is 5.

    Parameters

    • a: number

      Start value.

    • b: number

      End value.

    • x: number

      The interpolation value between 0 and 1.

    Returns number

    The interpolated value, now between a and b.

Const lerpAngle

  • lerpAngle(angle1: number, angle2: number, x: number): number

  • Linearly interpolates between two angles (in degrees) by taking the shortest direction around the circle.

    Parameters

    • angle1: number

      Starting angle, in degrees.

    • angle2: number

      Destination angle, in degrees.

    • x: number

      The interpolation value between 0 and 1.

    Returns number

    Return the interpolated angle, in degrees.

Const log10

  • log10(arg: number): number

Const log2

  • log2(arg: number): number

Const logicalNegation

  • logicalNegation(bool: boolean): boolean

Const mod

  • mod(x: number, y: number): number

  • Modulo operation (the remainder after dividing one number by another)

    Parameters

    • x: number

      Dividend value.

    • y: number

      Divisor value.

    Returns number

    Return the remainder for the values.

Const normalize

  • normalize(val: number, min: number, max: number): number

  • Normalize a value between min and max to a value between 0 and 1.

    Parameters

    • val: number

      The value to normalize

    • min: number

      The minimum

    • max: number

      The maximum

    Returns number

    The normalized value between 0 and 1

Const nthroot

  • nthroot(x: number, n: number): number

Const pi

  • pi(): number

Const resolveAsyncEventsFunction

  • resolveAsyncEventsFunction(eventsFunctionContext: EventsFunctionContext): void

Const roundTo

  • roundTo(value: number, decimalPlace: number): number

Const sceneVariableExists

  • sceneVariableExists(runtimeScene: RuntimeScene, variableName: string): boolean

Const sec

  • sec(arg: number): number

Const setVariableBoolean

  • setVariableBoolean(variable: Variable, newValue: boolean): void

Const sign

  • sign(arg: number): number

  • Returns the sign of the number. This checks if the value is positive, negative or zero.

    Parameters

    • arg: number

      Value.

    Returns number

    Return the sign for the value (1, -1 or 0).

Const sinh

  • sinh(arg: number): number

Const tanh

  • tanh(arg: number): number

Const toNumber

  • toNumber(str: string): number

Const toString

  • toString(num: number): string

Const toggleVariableBoolean

  • toggleVariableBoolean(variable: Variable): void

Const trunc

  • trunc(x: number): number

Const valuePush

  • valuePush(array: Variable, value: string | number | boolean): void

Const variableChildExists

  • variableChildExists(variable: Variable, childName: string): boolean

Const variableClearChildren

  • variableClearChildren(variable: Variable): void

Const variablePushCopy

Const variableRemoveAt

  • variableRemoveAt(array: Variable, index: number): void

Const variableRemoveChild

  • variableRemoveChild(variable: Variable, childName: string): void

Generated using TypeDoc