ODStat 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 statistic.

This single statistic doesn't do anything except defining the rules of this statistic. Use it in a stats scope to register a new statistic. A statistic can also include a priority to choose the render priority.

It's recommended to use the ODBasicStat & ODDynamicStat classes instead of this one!

View Source

Properties

• id
• priority
• render
• value

Methods

• constructor
• _change
• changed

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

inherited id class ➜ api.ODId

The id of this data.

View Source

---

priority number ➜ number

The priority of this statistic.

View Source

---

render type ➜ api.ODStatRenderer

The render function of this statistic.

View Source

---

value type ➜ null|api.ODValidStatValue

The value of this statistic.

View Source

---

Methods

---

constructor() function ➜ api.ODStat

(no description)

View Parameters (4)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
• priority: number ➜ number - Parameter Description Lorem Ipsum.
• render: type ➜ api.ODStatRenderer - Parameter Description Lorem Ipsum.
• value: type ➜ api.ODValidStatValue - 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 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

---

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!