e2 docs custom prop

Jump to table of contents

Custom/prop

= propSpawn( Model, Frozen)

Use the model string or a template entity to spawn a prop. You can set the position and/or the rotation as well. The last number indicates frozen/unfrozen. (40 ops)

= propSpawn( Template, Frozen)

Entity template, Frozen Spawns a prop with the model of the template entity. If frozen is 0, then it will spawn unfrozen. (40 ops)

= propSpawn( Model, Pos, Frozen)

Model path, Position, Frozen Spawns a prop with the model denoted by the string filepath at the position denoted by the vector. If frozen is 0, then it will spawn unfrozen. (40 ops)

= propSpawn( Template, Pos, Frozen)

Entity template, Position, Frozen Spawns a prop with the model of the template entity at the position denoted by the vector. If frozen is 0, then it will spawn unfrozen. (40 ops)

= propSpawn( Model, Rot, Frozen)

Model path, Rotation, Frozen Spawns a prop with the model denoted by the string filepath and rotated to the angle given. If frozen is 0, then it will spawn unfrozen. (40 ops)

= propSpawn( Template, Rot, Frozen)

Rotation, Frozen Spawns a prop with the model of the template entity and rotated to the angle given. If frozen is 0, then it will spawn unfrozen. (40 ops)

= propSpawn( Model, Pos, Rot, Frozen)

Model path, Position, Rotation, Frozen Spawns a prop with the model denoted by the string file path, at the position denoted by the vector, and rotated to the angle given. If frozen is 0, then it will spawn unfrozen. (40 ops)

= propSpawn( Template, Pos, Rot, Frozen)

Position, Rotation, Frozen Spawns a prop with the model of the template entity, at the position denoted by the vector, and rotated to the angle given. If frozen is 0, then it will spawn unfrozen. (40 ops)

= seatSpawn( Model, Frozen)

Model path, Frozen Spawns a prop with the model denoted by the string filepath. If frozen is 0, then it will spawn unfrozen. (60 ops)

= seatSpawn( Model, Pos, Rot, Frozen)

Model path, Frozen Spawns a prop with the model denoted by the string filepath. If frozen is 0, then it will spawn unfrozen. (60 ops)

:propDelete()

Deletes the specified prop. (10 ops)

:propBreak()

Breaks/Explodes breakable/explodable props (Useful for Mines). (10 ops)

:use()

Simulates a player pressing their use key on the entity. (10 ops)

= :propDelete()

Deletes all the props in the given table, returns the amount of props deleted. (30 ops)

= :propDelete()

Deletes all the props in the given array, returns the amount of props deleted. (30 ops)

propDeleteAll()

Removes all entities spawned by this E2 (30 ops)

:propManipulate( Pos, Rot, Freeze, Gravity, Notsolid)

Allows to do any single prop core function in one term (position, rotation, freeze, gravity, notsolid) (10 ops)

:propFreeze( Freeze)

Passing 0 unfreezes the entity, everything else freezes it. (10 ops)

:propNotSolid( Notsolid)

Passing 0 makes the entity solid, everything else makes it non-solid. (10 ops)

:propDraw( Drawenable)

Passing 0 disables rendering for the entity (makes it really invisible) (10 ops)

:propShadow( Shadowenable)

Passing 0 disables rendering for the entity's shadow (10 ops)

:propGravity( Gravity)

Passing 0 makes the entity weightless, everything else makes it weighty. (10 ops)

:propDrag( Drag)

Passing 0 makes the entity not be affected by drag (10 ops)

:propInertia( Inertia)

Sets the directional inertia (10 ops)

:propSetBuoyancy( Buoyancy)

Sets the prop's buoyancy ratio from 0 to 1 (10 ops)

:propSetFriction( Friction)

Sets prop's friction coefficient (default is 1) (10 ops)

= :propGetFriction()

Gets prop's friction coefficient (10 ops)

:propSetElasticity( Elasticity)

Sets prop's elasticity coefficient (default is 1) (10 ops)

= :propGetElasticity()

Gets prop's elasticity coefficient (10 ops)

:propMakePersistent( Persistent)

Setting to 1 will make the prop persistent. (10 ops)

:propPhysicalMaterial( Physprop)

Changes the surface material of a prop (eg. wood, metal, ... See Material_surface_properties ). (10 ops)

= :propPhysicalMaterial()

Returns the surface material of a prop. (10 ops)

:propSetVelocity( Velocity)

Sets the velocity of the prop for the next iteration (10 ops)

:propSetVelocityInstant( Velocity)

Sets the initial velocity of the prop (10 ops)

:propStatic( Static)

Sets to 1 to make the entity static (disables movement, physgun, unfreeze, drive...) or 0 to cancel. (10 ops)

:reposition( Pos)

Deprecated. Kept for backwards-compatibility. (20 ops)

:setPos( Pos)

Sets the position of an entity. (20 ops)

:setAng( Rot)

Set the rotation of an entity. (20 ops)

:rerotate( Rot)

Deprecated. Kept for backwards-compatibility. (20 ops)

:parentTo( Target)

Parents one entity to another. (20 ops)

:deparent()

Unparents an entity, so it moves freely again. (5 ops)

:parentTo()

Parents one entity to another. (5 ops)

propSpawnEffect( On)

Set to 1 to enable prop spawn effect, 0 to disable. (1 ops)

propSpawnUndo( On)

Set to 0 to force prop removal on E2 shutdown, and suppress Undo entries for props. (1 ops)

= propCanCreate()

Returns 1 when propSpawn() will successfully spawn a prop until the limit is reached. (1 ops)