Show raw api
{
"functions": [
{
"name": "new",
"desc": "Constructs a new ObservableSortedList",
"params": [
{
"name": "isReversed",
"desc": "",
"lua_type": "boolean"
},
{
"name": "compare",
"desc": "",
"lua_type": "function"
}
],
"returns": [
{
"desc": "",
"lua_type": "ObservableSortedList<T>"
}
],
"function_type": "static",
"source": {
"line": 44,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "isObservableSortedList",
"desc": "Returns whether the value is an observable list",
"params": [
{
"name": "value",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 109,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "Observe",
"desc": "Observes the list, allocating a new list in the process.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<{ T }>"
}
],
"function_type": "method",
"source": {
"line": 118,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "__iter",
"desc": "Allows iteration over the observable map",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(T) -> ((T, nextIndex: any) -> ...any, T?)"
}
],
"function_type": "method",
"source": {
"line": 131,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "IterateRange",
"desc": "Iterates over an index range",
"params": [
{
"name": "start",
"desc": "",
"lua_type": "number"
},
{
"name": "finish",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "(T) -> ((T, nextIndex: any) -> ...any, T?)"
}
],
"function_type": "method",
"source": {
"line": 146,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "FindFirstKey",
"desc": "Gets the first node for a given symbol",
"params": [
{
"name": "content",
"desc": "",
"lua_type": "T"
}
],
"returns": [
{
"desc": "",
"lua_type": "Symbol"
}
],
"function_type": "method",
"source": {
"line": 214,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "Contains",
"desc": "Returns true if the value exists",
"params": [
{
"name": "content",
"desc": "",
"lua_type": "T"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "method",
"source": {
"line": 228,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "ObserveItemsBrio",
"desc": "Observes all items in the list",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<T, Symbol>>"
}
],
"function_type": "method",
"source": {
"line": 239,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "ObserveIndex",
"desc": "Observes the index as it changes, until the entry at the existing\nindex is removed.",
"params": [
{
"name": "indexToObserve",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "method",
"source": {
"line": 280,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "ObserveAtIndex",
"desc": "Observes the current value at a given index. This can be useful for observing\nthe first entry, or matching stuff up to a given slot.",
"params": [
{
"name": "indexToObserve",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<(T, Key)>"
}
],
"function_type": "method",
"source": {
"line": 298,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "ObserveIndexByKey",
"desc": "Observes the index as it changes, until the entry at the existing\nnode is removed.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "SortedNode"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "method",
"source": {
"line": 321,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "GetIndexByKey",
"desc": "Gets the current index from the node",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "SortedNode"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "method",
"source": {
"line": 342,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "GetCount",
"desc": "Gets the count of items in the list",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "method",
"source": {
"line": 352,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "GetList",
"desc": "Gets a list of all entries.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "{ T }"
}
],
"function_type": "method",
"source": {
"line": 360,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "ObserveCount",
"desc": "Observes the count of the list",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "method",
"source": {
"line": 372,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "Add",
"desc": "Adds the item to the list at the specified index",
"params": [
{
"name": "data",
"desc": "",
"lua_type": "T"
},
{
"name": "observeValue",
"desc": "",
"lua_type": "Observable<Comparable> | Comparable"
}
],
"returns": [
{
"desc": "Call to remove",
"lua_type": "callback"
}
],
"function_type": "method",
"source": {
"line": 382,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "Get",
"desc": "Gets the current item at the index, or nil if it is not defined.",
"params": [
{
"name": "index",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "T?"
}
],
"function_type": "method",
"source": {
"line": 570,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "RemoveByKey",
"desc": "Removes the item from the list if it exists.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "SortedNode"
}
],
"returns": [
{
"desc": "",
"lua_type": "T"
}
],
"function_type": "method",
"source": {
"line": 586,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "Destroy",
"desc": "Cleans up the ObservableSortedList and sets the metatable to nil.",
"params": [],
"returns": [],
"function_type": "method",
"source": {
"line": 595,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "new",
"desc": "Constructs a new ObservableSortedList",
"params": [
{
"name": "isReversed",
"desc": "",
"lua_type": "boolean"
},
{
"name": "compare",
"desc": "",
"lua_type": "function"
}
],
"returns": [
{
"desc": "",
"lua_type": "ObservableSortedList<T>"
}
],
"function_type": "static",
"source": {
"line": 52,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "Observe",
"desc": "Observes the list, allocating a new list in the process.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<{ T }>"
}
],
"function_type": "method",
"source": {
"line": 113,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "__iter",
"desc": "Allows iteration over the observable map",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(T) -> ((T, nextIndex: any) -> ...any, T?)"
}
],
"function_type": "method",
"source": {
"line": 131,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "isObservableSortedList",
"desc": "Returns whether the value is an observable list",
"params": [
{
"name": "value",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 155,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "ObserveItemsBrio",
"desc": "Observes all items in the list",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<T, Symbol>>"
}
],
"function_type": "method",
"source": {
"line": 163,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "FindFirstKey",
"desc": "Gets the first key for a given symbol",
"params": [
{
"name": "content",
"desc": "",
"lua_type": "T"
}
],
"returns": [
{
"desc": "",
"lua_type": "Symbol"
}
],
"function_type": "method",
"source": {
"line": 198,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "ObserveIndex",
"desc": "Observes the index as it changes, until the entry at the existing\nindex is removed.",
"params": [
{
"name": "indexToObserve",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "method",
"source": {
"line": 215,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "ObserveAtIndex",
"desc": "Observes the current value at a given index. This can be useful for observing\nthe first entry, or matching stuff up to a given slot.",
"params": [
{
"name": "indexToObserve",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<T>"
}
],
"function_type": "method",
"source": {
"line": 233,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "ObserveIndexByKey",
"desc": "Observes the index as it changes, until the entry at the existing\nkey is removed.",
"params": [
{
"name": "key",
"desc": "",
"lua_type": "Symbol"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "method",
"source": {
"line": 251,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "GetIndexByKey",
"desc": "Gets the current index from the key",
"params": [
{
"name": "key",
"desc": "",
"lua_type": "Symbol"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "method",
"source": {
"line": 272,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "GetCount",
"desc": "Gets the count of items in the list",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "method",
"source": {
"line": 285,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "GetList",
"desc": "Gets a list of all entries.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "{ T }"
}
],
"function_type": "method",
"source": {
"line": 293,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "ObserveCount",
"desc": "Observes the count of the list",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "method",
"source": {
"line": 305,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "Add",
"desc": "Adds the item to the list at the specified index",
"params": [
{
"name": "item",
"desc": "",
"lua_type": "T"
},
{
"name": "observeValue",
"desc": "",
"lua_type": "Observable<Comparable> | Comparable"
}
],
"returns": [
{
"desc": "Call to remove",
"lua_type": "callback"
}
],
"function_type": "method",
"source": {
"line": 315,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "Get",
"desc": "Gets the current item at the index, or nil if it is not defined.",
"params": [
{
"name": "index",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "T?"
}
],
"function_type": "method",
"source": {
"line": 375,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "RemoveByKey",
"desc": "Removes the item from the list if it exists.",
"params": [
{
"name": "key",
"desc": "",
"lua_type": "Symbol"
}
],
"returns": [
{
"desc": "",
"lua_type": "T"
}
],
"function_type": "method",
"source": {
"line": 391,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "Destroy",
"desc": "Cleans up the ObservableSortedList and sets the metatable to nil.",
"params": [],
"returns": [],
"function_type": "method",
"source": {
"line": 718,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
}
],
"properties": [
{
"name": "ItemAdded",
"desc": "Fires when an item is added",
"lua_type": "Signal<T, number, Symbol>",
"readonly": true,
"source": {
"line": 71,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "ItemRemoved",
"desc": "Fires when an item is removed.",
"lua_type": "Signal<T, Symbol>",
"readonly": true,
"source": {
"line": 80,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "OrderChanged",
"desc": "Fires when the order could have changed",
"lua_type": "Signal",
"readonly": true,
"source": {
"line": 89,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "CountChanged",
"desc": "Fires when the count changes",
"lua_type": "Signal<number>",
"readonly": true,
"source": {
"line": 99,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedList.lua"
}
},
{
"name": "ItemAdded",
"desc": "Fires when an item is added",
"lua_type": "Signal<T, number, Symbol>",
"readonly": true,
"source": {
"line": 80,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "ItemRemoved",
"desc": "Fires when an item is removed.",
"lua_type": "self._maid:Add(Signal<T, Symbol>)",
"readonly": true,
"source": {
"line": 88,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "OrderChanged",
"desc": "Fires when an item's order changes.",
"lua_type": "self._maid:Add(Signal<T, Symbol>)",
"readonly": true,
"source": {
"line": 96,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
},
{
"name": "CountChanged",
"desc": "Fires when the count changes.",
"lua_type": "RBXScriptSignal",
"source": {
"line": 103,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
}
],
"types": [],
"name": "ObservableSortedList",
"desc": "A list that can be observed for blend and other components and maintains sorting order.\n\nThis class is very expensive to use as it enforces maintaining order on the object. Each entries produces\nwhat is most likely 4-5 tables, and changing can result in O(n) table construction and deltas.\n\nHowever, for small lists that don't change frequently, such as a global leaderboard, this can be\na nice small interactive class.\n\nFor performance reasons this class defers firing events until the next defer() event frame.\n\nThis class always prefers to add equivalent elements to the end of the list if they're not in the list.\nOtherwise it prefers minimal movement.",
"source": {
"line": 17,
"path": "src/observablecollection/src/Shared/SortedList/ObservableSortedListOld.lua"
}
}