Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Accessors

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): any
  • Allows to enable / disable target game logic.

    Returns boolean

  • Allows to enable / disable target game logic.

    Parameters

    • value: boolean

    Returns any

id

  • get id(): number
  • Returns ID number of target game logic.

    Returns number

labels

  • Returns all labels attached to selected game logic as an array*.

    Returns YLogicLabel[]

name

  • get name(): string
  • set name(value: string): any
  • Allows to get / set game logic name.

    Returns string

  • Allows to get / set game logic name.

    Parameters

    • value: string

    Returns any

position

  • Allows to get / set position of target game logic. This is especially useful when getting the location of a Reference Point. When using Set position, the game logic will immediately go to that position, unlike using a Position Animator.

    Returns YVector3

  • Allows to get / set position of target game logic. This is especially useful when getting the location of a Reference Point. When using Set position, the game logic will immediately go to that position, unlike using a Position Animator.

    Parameters

    Returns any

quaternion

rotation

  • Allows to get / set rotation of target game logic. When using Set Rotation, the game logic will immediately go to that rotation, unlike using a Rotation Animator.

    Returns YVector3

  • Allows to get / set rotation of target game logic. When using Set Rotation, the game logic will immediately go to that rotation, unlike using a Rotation Animator.

    Parameters

    Returns any

scale

  • Allows to get / set size of target game logic.

    Returns YVector3

  • Allows to get / set size of target game logic.

    Parameters

    Returns any

Methods

addStorage

attachLabel

  • Allows to attach selected Game Logic Label to target Game Logic.

    Parameters

    Returns void

destroy

  • destroy(): void
  • Deletes the selected game logic*.

    Returns void

getStorageData

hasLabel

  • Returns whether the target Game Logic has selected Label attached.

    Parameters

    Returns boolean

hasStorage

  • Returns whether the game logic has the selected storage attached.

    Parameters

    Returns boolean

removeLabel

  • Allows to remove selected Game Logic Label from target Game Logic.

    Parameters

    Returns void

removeStorage

setLookAt

setTarget

transformPosition

transformRotation

Static cameraLookAt

  • Forces players camera to focus on given position.

    Parameters

    Returns void

Static disableCustomCamera

  • disableCustomCamera(character: YCharacter): void
  • Disables custom camera for the target player.

    Parameters

    Returns void

Static enableCustomCamera

  • Enables custom camera for the target player.

    Parameters

    Returns void

Static fadeIn

  • Allows to force fade in effect onto target player.

    Parameters

    Returns void

Static fadeOut

  • Allows to force fade out effect from the target player.

    Parameters

    Returns void

Static getActiveCustomCamera

  • Returns current active Custom camera of target player.

    Parameters

    Returns YCamera

Static is

  • Returns whether the target object is game logic or not.

    Parameters

    Returns boolean

Static screenShake

  • screenShake(player: YCharacter, intensity: number, frequency: number, duration: number, sound: YSound): void
  • Shakes the camera of the target player for a given time period.

    Parameters

    • player: YCharacter
    • intensity: number
    • frequency: number
    • duration: number
    • sound: YSound

    Returns void

Static screenShakeAt

  • screenShakeAt(position: YVector3, radius: number, fallOffDistance: number, intensity: number, frequency: number, duration: number, sound: YSound): void
  • Shakes the camera at the given position of any player in the given radius.

    Parameters

    • position: YVector3
    • radius: number
    • fallOffDistance: number
    • intensity: number
    • frequency: number
    • duration: number
    • sound: YSound

    Returns void

Static spawn

Generated using TypeDoc