Skip to main content

ODStatScope class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview​

This is an Open Ticket stat scope.

A scope can contain multiple stats. Every scope is seperated from other scopes. Here, you can read & write the values of all stats.

The built-in Open Ticket scopes are: global, user, ticket

View Source

Properties​

Methods​

Other​

Properties​

database type ➜ null|api.ODDatabase​

Alias to Open Ticket stats database.

View Source

id class ➜ api.ODId​

The id of this statistics scope.

View Source

name string ➜ string​

The name of this scope (used in embed title)

View Source

ready boolean ➜ boolean​

Is this stat scope already initialized?

View Source

inherited redirects class ➜ api.ODManagerRedirectHelper​

Handle all redirects in this ODManager

View Source

Methods​

constructor() function ➜ api.ODStatScope​

(no description)

View Parameters (2)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • name: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited protected _change() function ➜ void​

Trigger an onChange() event in the parent ODManager of this class.

View Source

inherited add() function ➜ boolean​

Add data to the manager. The id will be fetched from the data class! You can optionally select to overwrite existing data!

View Parameters (2)
  • data: type ➜ api.ODStat|(api.ODStat[]) - Parameter Description Lorem Ipsum.
  • overwrite: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

inherited changed() function ➜ void​

(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.

View Parameters (1)
  • callback: type ➜ null|(() => void) - Parameter Description Lorem Ipsum.

View Source

inherited exists() function ➜ boolean​

Check if data that matches the ODId exists. Returns a boolean.

View Parameters (1)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

inherited get() function ➜ null|api.ODStat​

Get data that matches the ODId. Returns the found data.

View Parameters (1)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

inherited getAll() function ➜ api.ODStat[]​

Get all data inside this manager

View Source

inherited getFiltered() function ➜ api.ODStat[]​

Get all data that matches inside the filter function

View Parameters (1)

View Source

inherited getIds() function ➜ api.ODId[]​

Get a list of all the ids inside this manager

View Source

inherited getLength() function ➜ number​

Get the length of the data inside this manager

View Source

inherited getRegex() function ➜ api.ODStat[]​

Get all data that matches the regex

View Parameters (1)
  • regex: type ➜ RegExp - Parameter Description Lorem Ipsum.

View Source

getStat() function ➜ Promise​

Get the value of a statistic. The scopeId is the unique id of the user, channel, role, etc that the stats are related to.

View Parameters (2)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • scopeId: string ➜ string - Parameter Description Lorem Ipsum.

View Source

init() function ➜ string[]​

Initialize this stat scope & return a list of all statistic ids in the following format: <scopeid>_<statid>

View Source

inherited loopAll() function ➜ Promise​

Run an iterator over all data in this manager. This method also supports async-await behaviour!

View Parameters (1)

View Source

inherited onAdd() function ➜ void​

Listen for when data is added to this manager.

View Parameters (1)

View Source

inherited onChange() function ➜ void​

Listen for when data is changed in this manager.

View Parameters (1)

View Source

inherited onRemove() function ➜ void​

Listen for when data is removed from this manager.

View Parameters (1)

View Source

inherited remove() function ➜ null|api.ODStat​

Remove data that matches the ODId. Returns the removed data.

View Parameters (1)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

render() function ➜ Promise​

Render all stats in this scope for usage in a discord message/embed.

View Parameters (4)
  • scopeId: string ➜ string - Parameter Description Lorem Ipsum.
  • guild: type ➜ discord.Guild - Parameter Description Lorem Ipsum.
  • channel: type ➜ discord.TextBasedChannel - Parameter Description Lorem Ipsum.
  • user: type ➜ discord.User - Parameter Description Lorem Ipsum.

View Source

resetStat() function ➜ Promise​

Reset the value of a statistic to the initial value. The scopeId is the unique id of the user, channel, role, etc that the stats are related to.

View Parameters (2)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • scopeId: string ➜ string - Parameter Description Lorem Ipsum.

View Source

setStat() function ➜ Promise​

Set, increase or decrease the value of a statistic. The scopeId is the unique id of the user, channel, role, etc that the stats are related to.

View Parameters (4)

View Source

useDatabase() function ➜ void​

Select the database to use to read/write all stats from/to. (Automatically assigned when used in ODStatsManager)

View Parameters (1)
  • database: class ➜ api.ODDatabase - Parameter Description Lorem Ipsum.

View Source

inherited useDebug() function ➜ void​

Use the Open Ticket debugger in this manager for logs

View Parameters (2)
  • debug: class ➜ api.ODDebugger - Parameter Description Lorem Ipsum.
  • debugname: string ➜ string - Parameter Description Lorem Ipsum.

View Source

Defaults​

under construction

We're still working on this part of the documentation!

Examples​

under construction

We're still working on this part of the documentation!