Class Bounty

Represents a bounty.

Constructors

`Private`constructor

new Bounty(
    properties:
        | {
            creationTime?: number;
            id?: undefined;
            new?: true;
            playerId: string;
            status?: undefined;
            targetId: string;
            valid?: undefined;
            value: bigint;
        }
        | {
            creationTime: number;
            id: bigint;
            new: false;
            playerId: string;
            status: "none"
            | "canceled"
            | "deleted"
            | "claimed";
            targetId: string;
            valid: boolean;
            value: bigint;
        },
): Globals.modules.main.Bounty
Creates a new bounty.
Parameters
- properties:
      | {
          creationTime?: number;
          id?: undefined;
          new?: true;
          playerId: string;
          status?: undefined;
          targetId: string;
          valid?: undefined;
          value: bigint;
      }
      | {
          creationTime: number;
          id: bigint;
          new: false;
          playerId: string;
          status: "none"
          | "canceled"
          | "deleted"
          | "claimed";
          targetId: string;
          valid: boolean;
          value: bigint;
      }
  The properties of the bounty.
  - {
        creationTime?: number;
        id?: undefined;
        new?: true;
        playerId: string;
        status?: undefined;
        targetId: string;
        valid?: undefined;
        value: bigint;
    }
    OptionalcreationTime?: number
    The creation time of this bounty. Defaults to the current time.
    
    Optionalid?: undefined
    The unique identifier of this bounty.
    
    Optionalnew?: true
    Whether this bounty is new. Defaults to true.
    
    playerId: string
    The UUID of the player who placed this bounty.
    
    Optionalstatus?: undefined
    The status of this bounty. Defaults to undefined.
    
    targetId: string
    The UUID of the target of this bounty.
    
    Optionalvalid?: undefined
    Whether this bounty is valid. Defaults to undefined.
    
    value: bigint
    The value of this bounty.
  - {
        creationTime: number;
        id: bigint;
        new: false;
        playerId: string;
        status: "none" | "canceled" | "deleted" | "claimed";
        targetId: string;
        valid: boolean;
        value: bigint;
    }
    creationTime: number
    The creation time of this bounty. Defaults to the current time.
    
    Readonlyid: bigint
    The unique identifier of this bounty.
    
    new: false
    Whether this bounty is new. Defaults to true.
    
    playerId: string
    The UUID of the player who placed this bounty.
    
    status: "none" | "canceled" | "deleted" | "claimed"
    The status of this bounty. Defaults to undefined.
    
    targetId: string
    The UUID of the target of this bounty.
    
    valid: boolean
    Whether this bounty is valid. Defaults to undefined.
    
    value: bigint
    The value of this bounty.
Returns Globals.modules.main.Bounty
- Defined in modules/main/classes/Bounty.ts:72

Properties

creationTime

creationTime: number

The creation time of this bounty.

`Readonly`id

id: bigint

The unique identifier of this bounty.

playerId

playerId: string

The UUID of the player who placed this bounty.

status

status: "none" | "canceled" | "deleted" | "claimed" = "none"

The status of this bounty.

Default

"none"

targetId

targetId: string

The UUID of the target of this bounty.

valid

valid: boolean = true

Whether this bounty is valid.

Default

true

value

value: bigint

The value of this bounty.

Methods

cancel

cancel(): boolean
Cancels this bounty.

Returns boolean
Whether this bounty was canceled.
- Defined in modules/main/classes/Bounty.ts:144

claim

claim(claimer: Player): boolean
Claims this bounty.
Parameters
- claimer: Player
  The player who claimed this bounty.
Returns boolean
Whether this bounty was claimed.
- Defined in modules/main/classes/Bounty.ts:160

delete

delete(): boolean
Deletes this bounty.

Returns boolean
Whether this bounty was deleted.
- Defined in modules/main/classes/Bounty.ts:123

getLinkedSourceSavedPlayer

getLinkedSourceSavedPlayer(): undefined | Globals.modules.playersave.savedPlayer
Gets a savedPlayer instance for the source of this bounty.

Returns undefined | Globals.modules.playersave.savedPlayer
The saved player instance for the source of this bounty, or undefined if the source of this bounty has not been saved.
- Defined in modules/main/classes/Bounty.ts:183

getLinkedTargetSavedPlayer

getLinkedTargetSavedPlayer(): undefined | Globals.modules.playersave.savedPlayer
Gets a savedPlayer instance for the target of this bounty.

Returns undefined | Globals.modules.playersave.savedPlayer
The saved player instance for the target of this bounty, or undefined if the target of this bounty has not been saved.
- Defined in modules/main/classes/Bounty.ts:175

`Private`init

init(): void
Initializes this bounty.

Returns void
- Defined in modules/main/classes/Bounty.ts:114

toJSONB

toJSONB(): {
    creationTime: number;
    id: bigint;
    playerId: string;
    status: "none"
    | "canceled"
    | "deleted"
    | "claimed";
    targetId: string;
    valid: boolean;
    value: bigint;
}
Converts this bounty to a JSONB serializable object.

Returns {
    creationTime: number;
    id: bigint;
    playerId: string;
    status: "none" | "canceled" | "deleted" | "claimed";
    targetId: string;
    valid: boolean;
    value: bigint;
}
- Defined in modules/main/classes/Bounty.ts:189

`Static`getAllBounties

getAllBounties(): Globals.modules.main.Bounty[]
Retrieves all active bounties.

Returns Globals.modules.main.Bounty[]
An array of active bounties.
- Defined in modules/main/classes/Bounty.ts:308

`Static`getBountiesFromPlayer

getBountiesFromPlayer(playerId: string): Globals.modules.main.Bounty[]
Retrieves all bounties placed by the specified player.
Parameters
- playerId: string
  The player's UUID.
Returns Globals.modules.main.Bounty[]
An array of bounties placed by the player.
- Defined in modules/main/classes/Bounty.ts:285

`Static`getBountiesOnPlayer

getBountiesOnPlayer(targetId: string): Globals.modules.main.Bounty[]
Retrieves all bounties placed on the specified player.
Parameters
- targetId: string
  The target's UUID.
Returns Globals.modules.main.Bounty[]
An array of bounties placed on the target.
- Defined in modules/main/classes/Bounty.ts:294

`Static`getMergedBounties

getMergedBounties(): Globals.modules.main.Bounty[]
Returns Globals.modules.main.Bounty[]
Todo
Make this method functional.
- Defined in modules/main/classes/Bounty.ts:300

`Static`loadBounties

loadBounties(): void
Loads all saved bounties.

Returns void
Throws
If the saved bounties are not valid stringified JSONB.
- Defined in modules/main/classes/Bounty.ts:213

`Static`placeBountyOnPlayer

placeBountyOnPlayer(
    value: bigint,
    playerId: string,
    targetId: string,
    playerDisplayName?: string,
    targetDisplayName?: string,
    silent?: boolean,
    chargePlayer?: boolean,
    creationTime?: number,
): Globals.modules.main.Bounty
Places a bounty on the specified player.
Parameters
- value: bigint
  The bounty value.
- playerId: string
  The player's UUID.
- targetId: string
  The target's UUID.
- OptionalplayerDisplayName: string
  The player's display name.
- OptionaltargetDisplayName: string
  The target's display name.
- Optionalsilent: boolean = false
  If set to true, will not notify all online players of the bounty. Defaults to false.
- OptionalchargePlayer: boolean = true
  Whether to charge the player for the bounty. Defaults to true.
- OptionalcreationTime: number = ...
  The creation time of the bounty. Defaults to the current time.
Returns Globals.modules.main.Bounty
The created bounty.

Throws
If the player has already placed a bounty on the target.

Throws
If chargePlayer is true and the player does not have enough money to place the bounty.
- Defined in modules/main/classes/Bounty.ts:242

`Static`saveBounties

saveBounties(): void
Saves all loaded bounties.

Returns void
- Defined in modules/main/classes/Bounty.ts:222

Class Bounty

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Parameters

OptionalcreationTime?: number

Optionalid?: undefined

Optionalnew?: true

playerId: string

Optionalstatus?: undefined

targetId: string

Optionalvalid?: undefined

value: bigint

creationTime: number

Readonlyid: bigint

new: false

playerId: string

status: "none" | "canceled" | "deleted" | "claimed"

targetId: string

valid: boolean

value: bigint

Returns Globals.modules.main.Bounty

Properties

creationTime

Readonlyid

playerId

status

Default

targetId

valid

Default

value

Methods

cancel

Returns boolean

claim

Parameters

Returns boolean

delete

Returns boolean

getLinkedSourceSavedPlayer

Returns undefined | Globals.modules.playersave.savedPlayer

getLinkedTargetSavedPlayer

Returns undefined | Globals.modules.playersave.savedPlayer

Privateinit

Returns void

toJSONB

Returns { creationTime: number; id: bigint; playerId: string; status: "none" | "canceled" | "deleted" | "claimed"; targetId: string; valid: boolean; value: bigint;}

StaticgetAllBounties

Returns Globals.modules.main.Bounty[]

StaticgetBountiesFromPlayer

Parameters

Returns Globals.modules.main.Bounty[]

StaticgetBountiesOnPlayer

Parameters

Returns Globals.modules.main.Bounty[]

StaticgetMergedBounties

Returns Globals.modules.main.Bounty[]

Todo

StaticloadBounties

Returns void

Throws

StaticplaceBountyOnPlayer

Parameters

Returns Globals.modules.main.Bounty

Throws

Throws

StaticsaveBounties

Returns void

Settings

On This Page

`Private`constructor

`Optional`creationTime?: number

`Optional`id?: undefined

`Optional`new?: true

`Optional`status?: undefined

`Optional`valid?: undefined

`Readonly`id: bigint

`Readonly`id

`Private`init

Returns {
creationTime: number;
id: bigint;
playerId: string;
status: "none" | "canceled" | "deleted" | "claimed";
targetId: string;
valid: boolean;
value: bigint;
}

`Static`getAllBounties

`Static`getBountiesFromPlayer

`Static`getBountiesOnPlayer

`Static`getMergedBounties

`Static`loadBounties

`Static`placeBountyOnPlayer

`Static`saveBounties