Options
All
  • Public
  • Public/Protected
  • All
Menu

The object used to modify player's camera roll angle.

since

3.0

Hierarchy

Index

Constructors

  • Constructs new CameraRollModifier object and adds it to the global list. Remember that it must only be created on the client side, so you probably will have to use client packets.

    since

    3.0

    Returns CameraRollModifier

Properties

class: Class<Object>

Methods

  • clone(): any
  • equals(param0: any): boolean
  • Parameters

    • param0: any

    Returns boolean

  • finalize(): void
  • getModifier(): number
  • since

    3.0

    Returns number

    the value that will be added to the camera roll angle, in radians

  • getSmoothing(): number
  • since

    3.0

    Returns number

    smoothing power value for the following modifier object

  • hashCode(): number
  • isActive(): boolean
  • since

    3.0

    Returns boolean

    whether the following modifier object is enabled at the moment

  • isInterpolationEnabled(): boolean
  • since

    3.0

    Returns boolean

    whether the interpolation feature is enabled for the following modifier object

  • notify(): void
  • notifyAll(): void
  • Enables or disables builtin interpolation feature for the following CameraRollModifier. This feature will change the roll angle every frame for the changes to be smoother.

    By default the interpolation feature is enabled for a new-created CameraRollModifier.

    since

    3.0

    Parameters

    • interpolationEnabled: boolean

    Returns CameraRollModifier

    reference to itself to be used in sequential calls

  • Sets the value that will be added to the camera roll angle. This value must be in radians, so if you have it in degrees, you must divide it by pi and multiply it by 180.

    since

    3.0

    Parameters

    • modifier: number

    Returns CameraRollModifier

    reference to itself to be used in sequential calls

  • Sets smoothing power. This value is used in interpolation logics. It must be a value from 0 to 1 non-inclusively. If you put 1, the roll will stop, if you put 0, there will be no interpolation at all.

    This value is 0.85 by default, and you may just don't change it, as it already provides you with a smooth roll.

    since

    3.0

    Parameters

    • smoothing: number

    Returns CameraRollModifier

    reference to itself to be used in sequential calls

  • toString(): string
  • wait(): void
  • wait(param0: number): void
  • wait(param0: number, param1: number): void
  • Returns void

  • Parameters

    • param0: number

    Returns void

  • Parameters

    • param0: number
    • param1: number

    Returns void

Generated using TypeDoc