Class ScrollBar

Binds scripts to Events and executes them when triggered. Any script can access the ScriptComponent executing them through the variable script. See also: Scripting Overview, Script Events Guide.

Example

// Bind a function to the MouthOpened event
function onMouthOpen(eventData)
{
    print("mouth was opened");
}
var event = script.createEvent("MouthOpenedEvent");
event.bind(onMouthOpen);

Hierarchy (view full)

Constructors

constructor

Properties

api enabled name sceneObject uniqueIdentifier updatePriority

Accessors

boundingHeightOffset isEnabled overflow scrollBarMeshVisual scrollPercentage

Methods

createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName isOfType isSame onAwake removeEvent reset getTypeName

Constructors

constructor

Properties

api

api: Record<string, any>

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

name

name: string

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

Accessors

boundingHeightOffset

  • get boundingHeightOffset(): number

  • Returns number

    how far (in cm) the top edge of the ScrollBar mesh should sit from the edge of the canvas when at the top of the content.

  • set boundingHeightOffset(offset): void

  • Sets the offset between the top edge of the mesh and the edge of the canvas.

    Parameters

    • offset: number

      how far (in cm) the top edge of the ScrollBar mesh should sit from the edge of the canvas when at the top of the content.

    Returns void

isEnabled

  • get isEnabled(): boolean

  • Returns boolean

  • set isEnabled(enabled): void

  • Parameters

    • enabled: boolean

    Returns void

overflow

  • get overflow(): number

  • Returns number

scrollBarMeshVisual

scrollPercentage

  • get scrollPercentage(): number

  • Returns number

Methods

createEvent

destroy

getReferencedEvents

getSceneObject

getTransform

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

onAwake

  • onAwake(): void

  • Returns void

removeEvent

reset

  • reset(): void

  • Returns void

StaticgetTypeName

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods