Runtime classServer APIGenerated

Player

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

A connected M2O player.

Extends

BasePlayer

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:97

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:179

Removes this player’s animation-style override.

Returns

void

clearCollectedPinups()

clearCollectedPinups(): void

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

Forgets every pinup collectible this player has taken, putting all of them back in the world on their client.

Returns

void

clearHandModels()

clearHandModels(): void

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

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

Returns

void

emit()

emit(eventName, payloadJson?): void

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

Emits a named script event to this player’s client connection.

Parameters

eventName

string

Client event name.

payloadJson?

string

Optional JSON payload forwarded verbatim to the owning client.

Returns

void

Inherited from

BasePlayer.emit

getAmmo()

getAmmo(weaponId): CarriedWeapon | null

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

Returns the reserve and loaded ammunition of one carried weapon, as last reported by this player’s client.

Parameters

weaponId

number

weapons.tbl row identifier.

Returns

CarriedWeapon | null

The weapon’s counts, or null when the player does not carry it.

getAnimStyle()

getAnimStyle(): number

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

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:270

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:60

Returns the most recently owner-reported health value.

Returns

number

Current replicated health, including native damage.

getIP()

getIP(): string

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

Returns this player’s current remote network address.

Returns

string

Address string, or an empty string when the player or peer is unavailable.

Inherited from

BasePlayer.getIP

getMoney()

getMoney(): number

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

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:85

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: server/api.d.ts:4280

Reads this player’s nametag color.

Returns

number

Packed 0xAARRGGBB color; opaque white when untinted.

Inherited from

BasePlayer.getNametagColor

getNametagText()

getNametagText(): string

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

Reads this player’s nametag text override.

Returns

string

The override, or an empty string when the player’s own name is drawn.

Inherited from

BasePlayer.getNametagText

getTeam()

getTeam(): number

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

Returns the team this player belongs to.

Returns

number

The team id, or 0 when the player is on no team.

getVehicle()

getVehicle(): Vehicle | null

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

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.

getWeapons()

getWeapons(): CarriedWeapon[]

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

Returns every weapon this player carries with its reserve and loaded ammunition, as last reported by their client. Values are current to within one client frame, and stay readable in playerDisconnect.

Returns

CarriedWeapon[]

One entry per carried weapon; empty before the client’s first report.

giveAmmo()

giveAmmo(weaponId, amount): void

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

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:226

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:91

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:79

Checks the player’s most recently reported death state.

Returns

boolean

True when the player is dead.

isNametagHealthVisible()

isNametagHealthVisible(): boolean

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

Checks whether the health bar under this player’s nametag is shown.

Returns

boolean

True unless the health bar was hidden; false also when this game has no nametags.

Inherited from

BasePlayer.isNametagHealthVisible

isNametagVisible()

isNametagVisible(): boolean

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

Checks whether this player’s nametag is shown to other players.

Returns

boolean

True unless the nametag was hidden; false also when this game has no nametags.

Inherited from

BasePlayer.isNametagVisible

isPinupCollected()

isPinupCollected(pinupId): boolean

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

Checks whether this player has taken a pinup collectible.

Parameters

pinupId

number

Pinups.tbl collectible identifier.

Returns

boolean

True when the collectible is in this player’s collected set.

kick()

kick(reason?): void

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

Disconnects this player from the server.

Parameters

reason?

string

Optional reason shown to the disconnected player; omitting it uses the generic kicked reason.

Returns

void

Inherited from

BasePlayer.kick

kill()

kill(): void

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

Instantly kills this player on the owning client.

Returns

void

modelToHands()

modelToHands(enabled, leftModelId, rightModelId): void

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

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:213

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, useAnimSet?): boolean

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

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. If a one-shot leaves the controls locked, call stopAnim, or Controls.setEnabled(true) from a client script.

Parameters

name

string

Engine animation clip name, at most 62 characters (e.g. “sc_eat_hot_out”, or “CC_TAUNT01-A” with useAnimSet).

loop

boolean

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

useAnimSet?

boolean

False (default) plays the clip by its exact name; true looks it up in the ped’s current animation set, as set-member clips such as CC_TAUNT01-A require.

Returns

boolean

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

putInVehicle()

putInVehicle(vehicle, seat?): boolean

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

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:252

Removes all weapons from this player and switches to fists.

Returns

void

removeFromVehicle()

removeFromVehicle(animated?): boolean

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

Takes this player out of their current vehicle. The default is an instant warp; with animated the player climbs out normally, the car radio and in-car audio stop, and vehiclePlayerExited fires when the animation completes rather than immediately.

Parameters

animated?

boolean

Play the native get-out animation instead of warping; defaults to false.

Returns

boolean

True when the player was removed, or when the animated exit was started; false when the player is not in a vehicle.

removeMoney()

removeMoney(amount): void

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

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:247

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:54

Restores this player to full native health.

Returns

void

setAnimStyle()

setAnimStyle(category, style): boolean

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

Overrides this player’s walk and idle animation style.

Parameters

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:258

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:49

Sets this player’s health on the owning client.

Parameters

health

number

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

Returns

void

setInvincible()

setInvincible(enabled): void

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

Makes this player immune to every damage source: bullets, melee, explosions, fire, vehicle impacts, run-overs and falls, including while seated in a burning or exploding vehicle. Hit reactions and knockdowns still play, and kill() still kills. Resets to false on reconnect.

Parameters

enabled

boolean

True to make the player immune to all damage, false to restore it.

Returns

void

setModel()

setModel(modelIndex): void

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

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:147

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: server/api.d.ts:4323

Tints the text on this player’s nametag.

Parameters

color

number

Packed 0xAARRGGBB color.

Returns

void

Inherited from

BasePlayer.setNametagColor

setNametagHealthVisible()

setNametagHealthVisible(visible): void

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

Shows or hides the health bar under this player’s nametag, leaving the name itself alone.

Parameters

visible

boolean

True to show the health bar under this player’s name, false to hide it.

Returns

void

Inherited from

BasePlayer.setNametagHealthVisible

setNametagText()

setNametagText(text?): void

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

Overrides the text drawn on this player’s nametag.

Parameters

text?

string

Text to show instead of the player’s name, cut to 64 bytes; empty or omitted restores the name.

Returns

void

Inherited from

BasePlayer.setNametagText

setNametagVisible()

setNametagVisible(visible): void

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

Shows or hides the name over this player’s head for every other player. The health bar has its own switch, and each player can still hide all nametags locally.

Parameters

visible

boolean

True to show this player’s nametag to everyone, false to hide it.

Returns

void

Inherited from

BasePlayer.setNametagVisible

setPinupCollected()

setPinupCollected(pinupId, collected): void

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

Sets whether this player has taken a pinup collectible. The world entity is hidden or restored on this player’s client immediately, without waiting for the area to stream again.

Parameters

pinupId

number

Pinups.tbl collectible identifier.

collected

boolean

True to mark the collectible taken and hide it; false to restore it to the world.

Returns

void

setRandomModel()

setRandomModel(): void

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

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

Returns

void

setTeam()

setTeam(team): boolean

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

Puts this player on a team, which decides who may damage them.

Parameters

team

number

Team id from Team.create, or 0 to leave every team.

Returns

boolean

True when the team exists and was applied.

setUnlimitedAmmo()

setUnlimitedAmmo(enabled): void

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

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: server/api.d.ts:4154

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

BasePlayer.setVirtualWorld

setVisibleTo()

setVisibleTo(player): void

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

Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.

Parameters

player

Entity | null

Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.

Returns

void

Inherited from

BasePlayer.setVisibleTo

setWeaponAmmo()

setWeaponAmmo(weaponId, total, clip): void

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

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:73

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:193

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:43

Returns a readable representation of this player.

Returns

string

The player ID and nickname formatted for logging or debugging.

Inherited from

BasePlayer.toString

Properties

collectedPinups

readonly collectedPinups: number[]

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

Pinups.tbl identifiers of every collectible this player has taken.

discordId

readonly discordId: string

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

Authenticated Discord identifier, or an empty string when unavailable.

Inherited from

BasePlayer.discordId

epicId

readonly epicId: string

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

Epic Games account identifier the client reported, not verified by the server, or an empty string when unavailable.

Inherited from

BasePlayer.epicId

hardwareId

readonly hardwareId: string

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

Framework hardware identifier, or an empty string when unavailable.

Inherited from

BasePlayer.hardwareId

id

readonly id: number

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

Immutable network entity identifier.

Inherited from

BasePlayer.id

invincible

readonly invincible: boolean

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

True while setInvincible has made this player immune to damage.

ip

readonly ip: string

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

Current remote network address, or an empty string when unavailable.

Inherited from

BasePlayer.ip

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: server/api.d.ts:4245

Current round-trip latency in milliseconds, or -1 when unavailable.

Inherited from

BasePlayer.ping

position

position: Vector3

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

Authoritative world-space position; assignment forces replicated state.

Inherited from

BasePlayer.position

rotation

rotation: Vector3 | Quaternion

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

Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.

Inherited from

BasePlayer.rotation

state

readonly state: StateBag

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

Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.

Inherited from

BasePlayer.state

steamId

readonly steamId: string

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

Authenticated Steam identifier, or an empty string when unavailable.

Inherited from

BasePlayer.steamId

virtualWorld

readonly virtualWorld: number

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

Current virtual-world identifier.

Inherited from

BasePlayer.virtualWorld