Missing Documentation in Lua API Browser Tweet

[MB]

I tried implementing this today, octane.gui.NUMERIC_BOX, but i could not find any documentation of its properties in the api browser.
Am I blind?

thx

Mark

[stratified]

Hi Mark,

No, you're not blind We forgot to add the docs for this property, will be fixed in the next release.

Code: Select all

octane.gui.PROPS_NUMERIC_BOX

Properties for a numeric box.

Members:

 • function callback (writable)
    Gui event callback. The signature is: callback(component, event) with component the component on which the event happened and event of type octane.gui.eventType.

 • boolean enable (writable, bindable)
    true if the component is enabled.
    default: true

 • integer height (writable)
    Height of the component in pixels.
    default: 20

 • float maxValue (writable)
    Maximum value of the numeric box.
    default: 100.000000

 • float minValue (writable)
    Minimum value of the numeric box.
    default: 0.000000

 • function mouseCallback (writable)
    Mouse event callback. The signature is: callback(component, event, position {x, y}, wheelscroll {x, y}). Event is of type octane.gui.eventType.

 • string name (writable)
    Name of the component.
    default: "NEW_UNKNOWN_COMPONENT"

 • float step (writable)
    step interval between 2 discrete values
    default: 1.000000

 • integer type (read-only)
    Type of the component.
    default: 8

 • float value (writable, bindable)
    Value of the box in range [minValue, maxValue]
    default: 0.000000

 • integer width (writable)
    Width of the component in pixels.
    default: 100

 • integer x (writable)
    X-offset relative to the parent component in pixels.
    default: 0

 • integer y (writable)
    Y-offset relative to the parent component in pixels.
    default: 0


thanks,
Thomas

[MB]

Thanks Thomas,

Its working like a charm.