Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YCustomControls

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

enable

  • enable(player: YCharacter, active: boolean): void
  • Allows to **enable/**disable the target custom controls Game Logic for the target player.

    Parameters

    Returns void

enableCustomKeyAction

  • enableCustomKeyAction(player: YCharacter, action: number, active: boolean): void
  • Allows to **enable/**disable the custom key action of the target Custom controls for the target player.

    Parameters

    • player: YCharacter
    • action: number
    • active: boolean

    Returns void

enableDefaultKeyAction

  • Allows to **enable/**disable the default key action of the target Custom controls for the target player.

    Parameters

    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

isCustomKeyActionEnabled

  • isCustomKeyActionEnabled(player: YCharacter, action: number): boolean
  • Returns whether the player has the custom key action of the target custom controls enabled or not.

    Parameters

    Returns boolean

isDefaultKeyActionEnabled

isEnabled

  • Returns whether the target custom controls Game Logic is active for the target player.

    Parameters

    Returns boolean

removeLabel

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

    Parameters

    Returns void

removeStorage

transformPosition

transformRotation

Static enableDefaultKeyAction

Static enableDefaultKeyActionTransient

  • Allows to **enable/**disable the default key action of the target Custom controls for the target player.

    Parameters

    Returns void

Static is

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

    Parameters

    Returns boolean

Static isDefaultKeyActionEnabled

Static spawn

Generated using TypeDoc