Home

Plugin : List control

Author:Rex.Rainbow

Download

Properties

Color

  • Color for showing at editor.

Line height

  • Default line height, in pixels.

Total lines

  • Total lines count in this list.

Clamp OY

  • Clamp offset Y in vertical boundary.
    • Options : ["NO","Yes"]

Axis

  • Axis of scrolling.
    • Options : ["Horizontal","Vertical"]

Hotspot

  • Choose the location of the hot spot in the object.
    • Options : ["Top-left","Top","Top-right","Left","Center","Right","Bottom-left","Bottom","Bottom-right"]

Actions

Custom data

Action:Set value

  • Set custom data in a line.
    • Line index ( number ) : Line index.
    • Key ( string ) : The key of custom data.
    • Value ( number or string ) : The value to store in the line.

Action:Clean key in all lines

  • Clean key in all line.
    • Key ( string ) : The key of custom data.

Action:Clean all keys in all lines

  • Clean all keys in all line.

Insert

Action:Insert new lines

  • Insert new lines.
    • Insert at ( number ) : Line index for inserting.
    • Line number ( number ) : Line number for inserting.

Action:Insert lines

  • Insert lines with content.
    • Insert at ( number ) : Line index for inserting.
    • Content ( string ) : Content of lines in JSON string.

Action:Push new lines

  • Push new lines.
    • Where ( Combo ) : Whether to insert at the beginning or the end of the list.
      • Options : ["back","front"]
    • Line number ( number ) : Line number for inserting.

Action:Push lines

  • Push lines with content.
    • Where ( Combo ) : Whether to insert at the beginning or the end of the list.
      • Options : ["back","front"]
    • Content ( string ) : Content of lines in JSON string.

Instances

Action:Pin instance

  • Pin instance to current visible line under "Condition: On line visible". It will be destroyed while line is invisible.
    • Instance ( object ) : Instance belong the line.

Action:Unpin instance

  • Unpin instance from line.
    • Instance ( object ) : Instance belong the line.

Line - offset Y

Action:Set

  • Set offset Y of line.
    • Line index ( number ) : Line index.
    • OY ( number ) : Offset Y of a line, in pixels.

Line height

Action:Set default line height

  • Set default line height.
    • Line height ( number ) : Line height, in pixels.

Action:Set line height

  • Set line height.
    • Line index ( number ) : Line index.
    • Height ( number ) : Line height, in pixels.

List

Action:Set total lines count

  • Set total lines count.
    • Total lines count ( number ) : Total lines count of this list.

List - Offset Y

Action:Scroll by percentage

  • Scroll offset Y by percentage.
    • Percentage ( number ) : Scroll list, 0 is top, 1 is bottom.

List - offset Y

Action:Set

  • Set offset Y.
    • OY ( number ) : Offset Y of this list, in pixels. Start at 0.

Action:Add to

  • Add to Offset Y.
    • Value ( number ) : Add value to Offset Y, in pixels

Action:Scroll to index

  • Scroll offset Y to line lindex.
    • Line index ( number ) : Line index.

Remove

Action:Remove lines

  • Remove lines.
    • Remove from ( number ) : Line index for removing.
    • Line number ( number ) : Line number for removing.

SOL: instances

Action:Pick instances

  • Pick instances on line.
    • Line index ( number ) : Line index.
    • Object ( object ) : Object for picking

Action:Pick all instances

  • Pick all instances on line.
    • Line index ( number ) : Line index.

Visible

Action:Refresh

  • Refresh visible lines.

Expressions

Bound

Expression:LastBoundOY

  • Get last bound of OY under "Condition:On OY out of top bound", or "Condition:On OY out of bottom bound".

Custom data

Expression:At

  • Get value by line index and key. Add 3rd parameter for default value if this key is not existed.
    • Index ( number ) : Index of line.
    • Key ( string ) : The name of the key.

Expression:LastRemovedLines

  • Get custom data of last removed lines in JSON string after "Action: Remove lines".

Expression:CustomDataInLines

  • Get custom data of lines.
    • Start index ( number ) : Start index of line.
    • Line number ( number ) : Line number.

For each

Expression:CurLineIndex

  • Get current line index in "Condition: For each line", or "Condition: For each visible line".

Line height

Expression:DefaultLineHeight

  • Get default line height.

Expression:LineHeight

  • Get line height.
    • Index ( number ) : Index of line.

Line index

Expression:UID2LineIndex

  • Get line index of pinned instance by UID. (-1) is invalid.
    • UID ( number ) : UID of pinned instance.

List

Expression:TotalLinesCount

  • Get total lines count.

Expression:ListHeight

  • Get list height.

OY

Expression:OY

  • Get current OY.

Expression:BotomOY

  • Get bottom OY for showing the last cell, i.e. Scrollable length of current grid table.

Expression:TopOY

  • Get top OY.

Offset Y

Expression:LineIndex2LineTLY

  • Get top-left position Y by line index
    • Line index ( number ) : Line index.

Visible

Expression:LineCX

  • Get center position X of line in "Condition: On line visible", in pixels

Expression:FirstVisibleLineIndex

  • Get first visible line index.

Expression:LastVisibleLineIndex

  • Get last visible line index.

Visible - On visible

Expression:LineIndex

  • Get selected line index in "Condition: On line visible", or "Condition: On line invisible".

Expression:LineTLX

  • Get top-left position X of line in "Condition: On line visible", in pixels

Expression:LineTLY

  • Get top-left position Y of line in "Condition: On line visible", in pixels

Conditions

Bound

Condition:Is OY out of bound

  • Retrurn true if OY is out of bound.
    • Bound ( Combo ) : Bound types.
      • Options : ["Top bound","Bottom bound","Top or bottom bounds"]

Condition:On OY out of bound

  • Triggered when OY out of bound.
    • Bound ( Combo ) : Bound types.
      • Options : ["Top bound","Bottom bound","Top or bottom bounds"]

Filter

Condition:For each matched line

  • Repeat the event for each matched line.
    • Key ( string ) : The key of custom data.
    • Comparison ( cmp ) : Choose the way to compare data.
    • Value ( number ) : The value to compare the data to.

List

Condition:For each line

  • Repeat the event for each line in list.

Condition:For each line in a range

  • Repeat the event for each line in a range in list.
    • Start ( number ) : Start line index.
    • End ( number ) : Start line index.

SOL: instances

Condition:Pick instances

  • Pick instances on line.
    • Line index ( number ) : Line index.
    • Object ( object ) : Object for picking

Condition:Pick all instances

  • Pick all instances on line.
    • Line index ( number ) : Line index.

Visible

Condition:On line visible

  • Triggered when a line is visible.

Condition:On line invisible

  • Triggered when a line is invisible.

Condition:For each visible line

  • Repeat the event for each visible line.