Prop
Defined in: server/api.d.ts:1320
Replicated static world object created from a Mafia II model.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Prop(
id):Prop
Defined in: server/api.d.ts:1325
Creates a script wrapper for an existing prop with this ID; use Prop.create() to create a prop.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”Prop
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:1346
Destroys this replicated prop and removes it from connected clients.
Returns
Section titled “Returns”void
setVirtualWorld()
Section titled “setVirtualWorld()”setVirtualWorld(
world):void
Defined in: server/api.d.ts:4154
Moves this entity into another virtual world.
Parameters
Section titled “Parameters”number
Virtual-world identifier used to partition replication and visibility.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setVisibleTo()
Section titled “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
Section titled “Parameters”player
Section titled “player”Entity | null
Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”toString()
Section titled “toString()”toString():
string
Defined in: server/api.d.ts:1341
Returns a readable representation of this prop.
Returns
Section titled “Returns”string
The prop ID formatted for logging or debugging.
Inherited from
Section titled “Inherited from”create()
Section titled “create()”
staticcreate(x,y,z,model,rotation?,collision?,virtualWorld?):Prop
Defined in: server/api.d.ts:1359
Creates and replicates a static world prop.
Parameters
Section titled “Parameters”number
Initial world-space X coordinate.
number
Initial world-space Y coordinate.
number
Initial world-space Z coordinate.
number
Mafia II model identifier to instantiate.
rotation?
Section titled “rotation?”Optional orientation: a Quaternion, or a Vector3 of Euler angles in degrees.
collision?
Section titled “collision?”boolean
Optional solidity; pass false to spawn a pass-through prop with no collision. Defaults to true.
virtualWorld?
Section titled “virtualWorld?”number
Optional virtual-world ID used for visibility filtering.
Returns
Section titled “Returns”Prop
The newly created prop handle.
Properties
Section titled “Properties”collision
Section titled “collision”collision:
boolean
Defined in: server/api.d.ts:1335
Whether the prop is solid. Set false to make it pass-through for players, vehicles and physics.
readonlyid:number
Defined in: server/api.d.ts:4122
Immutable network entity identifier.
Inherited from
Section titled “Inherited from”
readonlymodel:number
Defined in: server/api.d.ts:1330
Mafia II model identifier used by this prop.
position
Section titled “position”position:
Vector3
Defined in: server/api.d.ts:4132
Authoritative world-space position; assignment forces replicated state.
Inherited from
Section titled “Inherited from”rotation
Section titled “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
Section titled “Inherited from”
readonlystate: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
Section titled “Inherited from”virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: server/api.d.ts:4127
Current virtual-world identifier.