Prop
Defined in: server/api.d.ts:1010
Replicated static world object created from a Mafia II model.
Extends
Section titled “Extends”Entity
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Prop(
id):Prop
Defined in: server/api.d.ts:1015
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
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:1036
Destroys this replicated prop and removes it from connected clients.
Returns
Section titled “Returns”void
setVirtualWorld()
Section titled “setVirtualWorld()”setVirtualWorld(
world):void
Defined in: shared.d.ts:83
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setVisibleTo()
Section titled “setVisibleTo()”setVisibleTo(
player):void
Defined in: shared.d.ts:84
Parameters
Section titled “Parameters”player
Section titled “player”Entity | null
Returns
Section titled “Returns”void
toString()
Section titled “toString()”toString():
string
Defined in: server/api.d.ts:1031
Returns a readable representation of this prop.
Returns
Section titled “Returns”string
The prop ID formatted for logging or debugging.
create()
Section titled “create()”
staticcreate(x,y,z,model,rotation?,collision?,virtualWorld?):Prop
Defined in: server/api.d.ts:1049
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 radians.
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:1025
Whether the prop is solid. Set false to make it pass-through for players, vehicles and physics.
readonlyid:number
Defined in: shared.d.ts:79
readonlymodel:number
Defined in: server/api.d.ts:1020
Mafia II model identifier used by this prop.
position
Section titled “position”position:
Vector3
Defined in: shared.d.ts:81
rotation
Section titled “rotation”rotation:
Vector3|Quaternion
Defined in: shared.d.ts:82
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: shared.d.ts:80