Preparing search index...

    This class provides visual feedback by squishing a specified SceneObject when it is hovered or triggered. It allows customization of the squish amount along the x-axis and y-axis.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    This property is no longer needed, you can use a reference to the ScriptComponent, including 'script', directly

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    horizontalSquish: number = 0.5

    This is how much the squishObject will squish along the x-axis.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    squishObject: SceneObject

    This is the SceneObject that will be squished on hover/trigger.

    uniqueIdentifier: string
    updatePriority: number
    verticalSquish: number = 0.5

    This is how much the squishObject will squish along the y-axis.

    Methods

    • Returns void

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Returns void