Skip to content

Attributes

This page documents the hooks defined by the attributes module.


AdjustStaminaOffset(client, offset)View Source

Purpose

Allows code to adjust the computed stamina gain or drain before it is applied.

Realm

Shared

Parameters

Player client The player whose stamina value is being updated.

number offset The pending stamina change for this tick. Negative values drain stamina and positive values regenerate it.

Returns

number|nil Return a replacement stamina offset to override the default value, or nil to leave it unchanged.