For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/reference/sdk/sapi/runtime/classes/Money.md.
  • English
  • Class: Money

    Defined in: sapi/runtime/economy.ts:109

    玩家侧余额缓存助手类。 底层统一通过 service registry 访问 economy.account.* 跨模块服务,并在本地维持短期缓存与并发防重。

    Constructors

    Constructor

    new Money(): Money;

    Returns

    Money

    Methods

    get()

    static get(player: Player): number;

    Defined in: sapi/runtime/economy.ts:124

    读取玩家当前余额;若尚未加载完成则返回当前缓存值或 0。

    Parameters

    ParameterTypeDescription
    playerPlayer目标玩家对象。

    Returns

    number

    玩家余额数值。


    getCached()

    static getCached(player: Player): number | null;

    Defined in: sapi/runtime/economy.ts:136

    读取本地缓存的玩家余额;若尚未加载则返回 null。

    Parameters

    ParameterTypeDescription
    playerPlayer目标玩家对象。

    Returns

    number | null

    缓存中的余额数值,无缓存时返回 null。


    getVersion()

    static getVersion(player: Player): number | null;

    Defined in: sapi/runtime/economy.ts:146

    读取本地缓存的账户版本号;若尚未加载则返回 null。

    Parameters

    ParameterTypeDescription
    playerPlayer目标玩家对象。

    Returns

    number | null

    缓存中的乐观锁版本号,无缓存时返回 null。


    setCached()

    static setCached(
       player: Player, 
       balance: number, 
       version?: number): void;

    Defined in: sapi/runtime/economy.ts:157

    写入本地缓存;若传入的 version 低于当前已缓存的版本号则跳过(防止过期的并发响应覆盖较新的数据)。

    Parameters

    ParameterTypeDefault valueDescription
    playerPlayerundefined目标玩家对象。
    balancenumberundefined最新的余额数值。
    versionnumber0最新的乐观锁版本号。

    Returns

    void


    load()

    static load(player: Player): Promise<number>;

    Defined in: sapi/runtime/economy.ts:178

    从服务端拉取玩家最新账户数据并更新本地缓存;自动复用进行中的并发请求。

    Parameters

    ParameterTypeDescription
    playerPlayer目标玩家对象。

    Returns

    Promise<number>

    最新的玩家账户余额。


    add()

    static add(player: Player, money: number): Promise<boolean>;

    Defined in: sapi/runtime/economy.ts:201

    增减玩家余额。传入正数为充值入账,负数为扣款;交易成功后会自动刷新本地缓存。

    Parameters

    ParameterTypeDescription
    playerPlayer目标玩家对象。
    moneynumber变动金额数值(正数入账,负数扣款)。

    Returns

    Promise<boolean>

    交易执行成功返回 true,失败返回 false。

    Properties

    PropertyModifierTypeDefault valueDescriptionDefined in
    UNITreadonly"节操""节操"默认货币单位显示名称(例如:“节操”)。sapi/runtime/economy.ts:111