Prop

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

Replicated static world object created from a Mafia II model.

Extends

• Entity

Constructors

Constructor

new Prop(id): Prop

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

Creates a script wrapper for an existing prop with this ID; use Prop.create() to create a prop.

Parameters

id

number

Network entity identifier.

Returns

Prop

Inherited from

Entity.constructor

Methods

attachTo()

attachTo(target, offset?, rotation?): void

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

Makes the prop follow a player or vehicle, stopping any moveTo. An attached prop has no collision and takes the target’s virtual world; it is released where it stands when the target is destroyed or disconnects.

Parameters

target

number | Player | Vehicle

Player or vehicle to follow, or its network entity ID.

offset?

Vector3

Optional position relative to the target, in its local axes (X right, Y forward, Z up). Defaults to the origin.

rotation?

Vector3 | Quaternion

Optional orientation relative to the target: a Quaternion, or a Vector3 of Euler angles in degrees.

Returns

void

---

destroy()

destroy(): void

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

Destroys this replicated prop and removes it from connected clients.

Returns

void

---

detach()

detach(): void

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

Releases an attached prop, leaving it at its target’s current pose.

Returns

void

---

moveTo()

moveTo(position, durationMs, rotation?, easing?): void

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

Glides the prop to a new pose, smoothly on every client, starting from where it is now. position and rotation report the destination at once; use isMoving to tell whether it has arrived. Throws while the prop is attached.

Parameters

position

Vector3

World-space destination.

durationMs

number

Travel time in milliseconds; 0 moves instantly. Capped at 10 minutes.

rotation?

Vector3 | Quaternion

Optional final orientation: a Quaternion, or a Vector3 of Euler angles in degrees. Defaults to the current orientation.

easing?

"linear" | "inQuad" | "outQuad" | "inOutQuad"

Optional speed curve. Defaults to “linear”.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

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

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

Entity.setVirtualWorld

---

setVisibleTo()

setVisibleTo(player): void

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

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

Entity.setVisibleTo

---

stop()

stop(): void

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

Halts a running moveTo where the prop is now.

Returns

void

---

toString()

toString(): string

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

Returns a readable representation of this prop.

Returns

string

The prop ID formatted for logging or debugging.

Inherited from

Entity.toString

---

create()

static create(x, y, z, model, rotation?, collision?, virtualWorld?): Prop

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

Creates and replicates a static world prop.

Parameters

x

number

Initial world-space X coordinate.

y

number

Initial world-space Y coordinate.

z

number

Initial world-space Z coordinate.

model

number

Mafia II model identifier to instantiate.

rotation?

Vector3 | Quaternion

Optional orientation: a Quaternion, or a Vector3 of Euler angles in degrees.

collision?

boolean

Optional solidity; pass false to spawn a pass-through prop with no collision. Defaults to true.

virtualWorld?

number

Optional virtual-world ID used for visibility filtering.

Returns

Prop

The newly created prop handle.

Properties

attachedTo

readonly attachedTo: number

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

Network entity ID of the player or vehicle this prop follows; 0 when it is free.

---

collision

collision: boolean

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

Whether the prop is solid. Set false to make it pass-through for players, vehicles and physics.

---

id

readonly id: number

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

Immutable network entity identifier.

Inherited from

Entity.id

---

isMoving

readonly isMoving: boolean

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

Whether a moveTo is still under way.

---

model

readonly model: number

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

Mafia II model identifier used by this prop.

---

position

position: Vector3

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

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

---

rotation

rotation: Vector3 | Quaternion

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

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

Inherited from

Entity.rotation

---

state

readonly state: StateBag

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

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

Entity.state

---

virtualWorld

readonly virtualWorld: number

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

Current virtual-world identifier.

Inherited from

Entity.virtualWorld