Class export=

Hierarchy

Pseudo<{ _GLBContents: { [key: string]: GlobalLeaderboardContent } }>
- export=

Constructors

constructor

new "export="(LeaderboardName: string, Version?: number): export=
Parameters
- LeaderboardName: string
- Version: number = ...
Returns export=
Overrides Pseudo<{ _GLBContents: { [key: string]: GlobalLeaderboardContent }; }>.constructor
- Defined in index.ts:502

Properties

Ascending

Ascending: boolean = false

AutomaticRefresh

AutomaticRefresh: number | boolean = true

DisableSaving

DisableSaving: boolean = false

processClientKeyRankFetch

processClientKeyRankFetch:
| undefined
| ((Player: Player, Key?: string) => unknown)

Replicated

Replicated: boolean | GlobalLeaderboardReplication = false

ReplicationTypes

ReplicationTypes: typeof GlobalLeaderboardReplication = GlobalLeaderboardReplication

Methods

AddEntry

AddEntry(key: string, content: number): void
Parameters
- key: string
- content: number
Returns void
- Defined in index.ts:304

BindToContent

BindToContent(
    callback: (
        content: GlobalLeaderboardContent,
    ) => usePropertyEffectCleanup,
): ServantNext
Parameters
- callback: (content: GlobalLeaderboardContent) => usePropertyEffectCleanup
Returns ServantNext
- Defined in index.ts:470

ClearProxyDataEntries

ClearProxyDataEntries(): void
Returns void
- Defined in index.ts:93

DeleteEntry

DeleteEntry(key: string): undefined | number
Parameters
- key: string
Returns undefined | number
- Defined in index.ts:359

FetchAsync

FetchAsync(range: number, isAscending?: boolean): void
Parameters
- range: number
- isAscending: boolean = ...
Returns void
- Defined in index.ts:245

FetchKeyAsync

FetchKeyAsync(key: string, noCache?: boolean): undefined | LocalEntry
Parameters
- key: string
- OptionalnoCache: boolean
Returns undefined | LocalEntry
- Defined in index.ts:230

FetchKeyInfoAsync

FetchKeyInfoAsync(
Key: string,
noCache?: boolean,
): undefined | LuaTuple<[FetchRankResults, LocalEntry]>
Parameters
- Key: string
- OptionalnoCache: boolean
Returns undefined | LuaTuple<[FetchRankResults, LocalEntry]>
- Defined in index.ts:218

FetchKeyRankAsync

FetchKeyRankAsync(key?: string): FetchRankResults
Parameters
- Optionalkey: string
Returns FetchRankResults
- Defined in index.ts:122

GetAsync

GetAsync(...args: [key: string, noCache?: boolean]): undefined | LocalEntry
Parameters
- ...args: [key: string, noCache?: boolean]
Returns undefined | LocalEntry
- Defined in index.ts:290

GetEntries

GetEntries(): { [key: string]: undefined | LocalEntry }
Returns { [key: string]: undefined | LocalEntry }
- Defined in index.ts:65

GetEntry

GetEntry(...args: [key: string, noCache?: boolean]): undefined | LocalEntry
Parameters
- ...args: [key: string, noCache?: boolean]
Returns undefined | LocalEntry
- Defined in index.ts:295

GetLocalEntry

GetLocalEntry(key: string): undefined | LocalEntry
Parameters
- key: string
Returns undefined | LocalEntry
- Defined in index.ts:188

ProxyDataEntries

ProxyDataEntries(
Total: number,
EntryTemplate?: Partial<{ Key: string; Rank: number; Value: number }>,
): void
Parameters
- Total: number
- OptionalEntryTemplate: Partial<{ Key: string; Rank: number; Value: number }>
Returns void
- Defined in index.ts:69

Refresh

Refresh(): void
Refreshes contents on the next frame.

Returns void
- Defined in index.ts:380

RemoveAsync

RemoveAsync(...args: [key: string]): undefined | number
Parameters
- ...args: [key: string]
Returns undefined | number
- Defined in index.ts:354

SetAsync

SetAsync(...args: [key: string, content: number]): void
Parameters
- ...args: [key: string, content: number]
Returns void
- Defined in index.ts:301

UpdateAsync

UpdateAsync(
    ...args: [
        key: string,
        updateFunc: (prevContent: undefined | number) => undefined | number,
    ],
): undefined | number
Parameters
- ...args: [
  key: string,
  updateFunc: (prevContent: undefined | number) => undefined | number,
  ]
Returns undefined | number
- Defined in index.ts:316

UpdateEntry

UpdateEntry(
key: string,
updateFunc: (prevContent: undefined | number) => undefined | number,
): undefined | number
Parameters
- key: string
- updateFunc: (prevContent: undefined | number) => undefined | number
Returns undefined | number
- Defined in index.ts:321

UpdateLocalEntry

UpdateLocalEntry(
key: string,
value: (old: undefined | number) => undefined | number,
): void
Parameters
- key: string
- value: (old: undefined | number) => undefined | number
Returns void
- Defined in index.ts:267
UpdateLocalEntry(key: string, value: undefined | number): void
Parameters
- key: string
- value: undefined | number
Returns void
- Defined in index.ts:268