Player

Defined in: server/api.d.ts:7

A connected M2O player.

Extends

• Player

Constructors

Constructor

new Player(id): Player

Defined in: server/api.d.ts:12

Creates a script wrapper for an existing connected player with this ID; it does not create a player.

Parameters

id

number

Network entity identifier.

Returns

Player

Methods

addMoney()

addMoney(amount): void

Defined in: server/api.d.ts:87

Adds cash to this player’s native inventory and HUD counter.

Parameters

amount

number

Cash amount in dollars to add.

Returns

void

---

clearAnimStyle()

clearAnimStyle(): void

Defined in: server/api.d.ts:149

Removes this player’s animation-style override.

Returns

void

---

clearHandModels()

clearHandModels(): void

Defined in: server/api.d.ts:187

Clears this player’s left-hand, right-hand, and mouth prop models.

Returns

void

---

emit()

emit(eventName, payloadJson?): void

Defined in: shared.d.ts:96

Parameters

eventName

string

payloadJson?

string

Returns

void

---

getAnimStyle()

getAnimStyle(): number

Defined in: server/api.d.ts:168

Returns the most recently replicated animation-set identifier.

Returns

number

The applied animation-set ID, or zero when no override is active.

---

getCurrentWeapon()

getCurrentWeapon(): number

Defined in: server/api.d.ts:239

Returns the most recently replicated held-weapon identifier.

Returns

number

The current weapons.tbl row ID; 1 represents fists.

---

getHealth()

getHealth(): number

Defined in: server/api.d.ts:50

Returns the most recently owner-reported health value.

Returns

number

Current replicated health, including native damage.

---

getIP()

getIP(): string

Defined in: shared.d.ts:97

Returns

string

---

getMoney()

getMoney(): number

Defined in: server/api.d.ts:99

Returns the most recently owner-reported cash balance.

Returns

number

Current balance in dollars, including native in-game spending.

---

getMovementState()

getMovementState(): "idle" | "walking" | "running" | "stopping"

Defined in: server/api.d.ts:75

Returns the player’s current replicated on-foot gait.

Returns

"idle" | "walking" | "running" | "stopping"

One of idle, walking, running, or stopping.

---

getNametagColor()

getNametagColor(): number

Defined in: shared.d.ts:105

Returns

number

---

getNametagText()

getNametagText(): string

Defined in: shared.d.ts:103

Returns

string

---

getVehicle()

getVehicle(): Vehicle | null

Defined in: server/api.d.ts:105

Returns the vehicle currently occupied by this player in any seat.

Returns

Vehicle | null

The current vehicle handle, or null when the player is not in a vehicle.

---

giveAmmo()

giveAmmo(weaponId, amount): void

Defined in: server/api.d.ts:202

Changes reserve ammunition for one of this player’s weapons.

Parameters

weaponId

number

weapons.tbl row identifier.

amount

number

Reserve ammunition delta; negative values remove ammunition.

Returns

void

---

giveWeapon()

giveWeapon(weaponId, ammo, equip): void

Defined in: server/api.d.ts:195

Adds a valid weapon to this player’s native inventory.

Parameters

weaponId

number

weapons.tbl row identifier.

ammo

number

Initial reserve ammunition amount.

equip

boolean

Whether the weapon should become the current weapon immediately.

Returns

void

---

isCrouching()

isCrouching(): boolean

Defined in: server/api.d.ts:81

Checks the player’s most recently replicated crouch state.

Returns

boolean

True when the player is crouching.

---

isDead()

isDead(): boolean

Defined in: server/api.d.ts:69

Checks the player’s most recently reported death state.

Returns

boolean

True when the player is dead.

---

isNametagHealthVisible()

isNametagHealthVisible(): boolean

Defined in: shared.d.ts:101

Returns

boolean

---

isNametagVisible()

isNametagVisible(): boolean

Defined in: shared.d.ts:99

Returns

boolean

---

kick()

kick(reason?): void

Defined in: shared.d.ts:95

Parameters

reason?

string

Returns

void

---

kill()

kill(): void

Defined in: server/api.d.ts:55

Instantly kills this player on the owning client.

Returns

void

---

modelToHands()

modelToHands(enabled, leftModelId, rightModelId): void

Defined in: server/api.d.ts:176

Shows or clears visual prop models in this player’s hands. Hand slots are shared with the equipped weapon.

Parameters

enabled

boolean

False clears both hand slots; true applies the supplied models.

leftModelId

number

weapons.tbl prop-row ID for the left hand; an unknown ID clears the slot.

rightModelId

number

weapons.tbl prop-row ID for the right hand; an unknown ID clears the slot.

Returns

void

---

modelToMouth()

modelToMouth(modelId): void

Defined in: server/api.d.ts:182

Shows a visual prop model in this player’s mouth.

Parameters

modelId

number

weapons.tbl prop-row ID; an unknown ID clears the mouth slot.

Returns

void

---

playAnim()

playAnim(name, loop): boolean

Defined in: server/api.d.ts:157

Plays a named animation clip on this player’s ped on every client. The owning client’s controls lock automatically while the animation holds the body; end a looping clip with stopAnim, and re-enable controls after a one-shot with stopAnim or setControlsEnabled(true).

Parameters

name

string

Bare engine clip name from a streamed animation set, at most 62 characters.

loop

boolean

True to repeat the clip until stopAnim is called; false to play it once.

Returns

boolean

True when the request was broadcast; false when the clip name is empty or longer than 16 characters.

---

putInVehicle()

putInVehicle(vehicle, seat?): boolean

Defined in: server/api.d.ts:113

Instantly warps this player into a vehicle seat without the enter animation, leaving any current vehicle first.

Parameters

vehicle

number | Vehicle

Vehicle handle or network entity ID.

seat?

number

Seat index where 0 is the driver seat; defaults to 0.

Returns

boolean

True when the player was seated; false when the vehicle is unknown or destroyed, the seat is out of range or held by another player, or the player is dead.

---

removeAllWeapons()

removeAllWeapons(): void

Defined in: server/api.d.ts:221

Removes all weapons from this player and switches to fists.

Returns

void

---

removeFromVehicle()

removeFromVehicle(): boolean

Defined in: server/api.d.ts:119

Instantly warps this player out of their current vehicle without the exit animation.

Returns

boolean

True when the player was removed; false when the player is not in a vehicle.

---

removeMoney()

removeMoney(amount): void

Defined in: server/api.d.ts:93

Removes cash from this player’s native inventory.

Parameters

amount

number

Cash amount in dollars to remove; removal is clamped to the available balance.

Returns

void

---

removeWeapon()

removeWeapon(weaponId): void

Defined in: server/api.d.ts:216

Removes one weapon from this player’s inventory and switches to fists when necessary.

Parameters

weaponId

number

weapons.tbl row identifier to remove.

Returns

void

---

restoreHealth()

restoreHealth(): void

Defined in: server/api.d.ts:44

Restores this player to full native health.

Returns

void

---

setAnimStyle()

setAnimStyle(category, style): boolean

Defined in: server/api.d.ts:144

Overrides this player’s walk and idle animation style.

Parameters

category

"common" | "weapon" | "panic" | "melee"

Animation-style registry category.

style

string

Registered style name within the selected category.

Returns

boolean

True when the category and style were found and applied.

---

setCurrentWeapon()

setCurrentWeapon(weaponId): void

Defined in: server/api.d.ts:227

Equips one of this player’s owned weapons.

Parameters

weaponId

number

Owned weapons.tbl row identifier to equip.

Returns

void

---

setHealth()

setHealth(health): void

Defined in: server/api.d.ts:39

Sets this player’s health on the owning client.

Parameters

health

number

Target health value, clamped to the pedestrian’s native maximum.

Returns

void

---

setModel()

setModel(modelIndex): void

Defined in: server/api.d.ts:125

Changes this player’s body model and replicates the new skin.

Parameters

modelIndex

number

Index in the shared player-model registry.

Returns

void

---

setModelColor()

setModelColor(colorId): void

Defined in: server/api.d.ts:136

Recolors this player’s current outfit without reloading the model; unsupported variants are ignored.

Parameters

colorId

number

Per-model palette variant; -1 restores the default.

Returns

void

---

setNametagColor()

setNametagColor(color): void

Defined in: shared.d.ts:104

Parameters

color

number

Returns

void

---

setNametagHealthVisible()

setNametagHealthVisible(visible): void

Defined in: shared.d.ts:100

Parameters

visible

boolean

Returns

void

---

setNametagText()

setNametagText(text?): void

Defined in: shared.d.ts:102

Parameters

text?

string

Returns

void

---

setNametagVisible()

setNametagVisible(visible): void

Defined in: shared.d.ts:98

Parameters

visible

boolean

Returns

void

---

setRandomModel()

setRandomModel(): void

Defined in: server/api.d.ts:130

Selects and applies a random model from the Mafia II player model directory.

Returns

void

---

setUnlimitedAmmo()

setUnlimitedAmmo(enabled): void

Defined in: server/api.d.ts:233

Enables or disables unlimited ammunition for this player.

Parameters

enabled

boolean

Whether this player’s ammunition is infinite.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

Defined in: shared.d.ts:83

Parameters

world

number

Returns

void

---

setVisibleTo()

setVisibleTo(player): void

Defined in: shared.d.ts:84

Parameters

player

Entity | null

Returns

void

---

setWeaponAmmo()

setWeaponAmmo(weaponId, total, clip): void

Defined in: server/api.d.ts:210

Sets absolute ammunition counts for one of this player’s weapons.

Parameters

weaponId

number

weapons.tbl row identifier.

total

number

Absolute reserve ammunition amount.

clip

number

Absolute loaded-clip amount; a negative value preserves the current clip.

Returns

void

---

spawn()

spawn(x, y, z): void

Defined in: server/api.d.ts:63

Respawns this player at a world-space position.

Parameters

x

number

Respawn world-space X coordinate.

y

number

Respawn world-space Y coordinate.

z

number

Respawn world-space Z coordinate.

Returns

void

---

stopAnim()

stopAnim(): void

Defined in: server/api.d.ts:162

Stops this player’s scripted animation on every client and re-enables the owning client’s controls.

Returns

void

---

toString()

toString(): string

Defined in: server/api.d.ts:33

Returns a readable representation of this player.

Returns

string

The player ID and nickname formatted for logging or debugging.

Properties

discordId

readonly discordId: string

Defined in: shared.d.ts:91

---

hardwareId

readonly hardwareId: string

Defined in: shared.d.ts:92

---

id

readonly id: number

Defined in: shared.d.ts:79

---

ip

readonly ip: string

Defined in: shared.d.ts:94

---

model

readonly model: number

Defined in: server/api.d.ts:22

Current shared player-model registry index, or -1 when unset or unknown.

---

modelColor

readonly modelColor: number

Defined in: server/api.d.ts:27

Current per-model palette variant, or -1 for the default.

---

nickname

readonly nickname: string

Defined in: server/api.d.ts:17

Current connected-player nickname.

---

ping

readonly ping: number

Defined in: shared.d.ts:93

---

position

position: Vector3

Defined in: shared.d.ts:81

---

rotation

rotation: Vector3 | Quaternion

Defined in: shared.d.ts:82

---

steamId

readonly steamId: string

Defined in: shared.d.ts:90

---

virtualWorld

readonly virtualWorld: number

Defined in: shared.d.ts:80