Shipment entity

Entity defined in core/entities/entities/cw_shipment

Shared definition of the cw_shipment entity: a non-spawnable anim entity named Shipment with a networked item Index and an ENT:GetItemTable accessor.

Summary

Methods

Draw()client
Draws the shipment model unless the ShipmentEntityDraw hook returns false.
Explode(scale)server
Plays a glass impact effect and a soft impact sound at the entity's position.
GetItemTable()shared
Returns the item the shipment contains.
HUDPaintTargetID(x, y, alpha)client
Draws the shipment title and the name of the item it contains when looked at.
Initialize()server
Sets up physics, simple use and 50 health for the shipment.
OnRemove()server
Drops the shipment's items into the world, unless the server is shutting down.
OnTakeDamage(damageInfo)server
Subtracts the damage from the shipment's health and destroys it at zero health.
SetItemTable(uniqueID, batch)server
Fills the shipment with new instances of an item and sets its model, weight and space.
SetupDataTables()shared
Sets up the networked Index integer holding the shipped item's index.
Think()server
Removes the shipment once a second check finds it outside the world.
UpdateTransmitState()server
Always transmits the shipment to every client.

Methods

ENT:Draw()

client gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/cl_init.lua:19

Draws the shipment model unless the ShipmentEntityDraw hook returns false.

ENT:Explode(scale)

server gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/init.lua:70

Plays a glass impact effect and a soft impact sound at the entity's position.

Parameters

  • scale Number optional, defaults to nil Unused; the effect scale is always 8

ENT:GetItemTable()

shared gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/shared.lua:22

Returns the item the shipment contains.

On the client it looks the item up by the networked index.

Returns

  • Item The shipped item, or nil if it is not set

ENT:HUDPaintTargetID(x, y, alpha)

client gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/cl_init.lua:7

Draws the shipment title and the name of the item it contains when looked at.

Parameters

  • x
  • y
  • alpha

ENT:Initialize()

server gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/init.lua:12

Sets up physics, simple use and 50 health for the shipment.

ENT:OnRemove()

server gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/init.lua:90

Drops the shipment's items into the world, unless the server is shutting down.

ENT:OnTakeDamage(damageInfo)

server gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/init.lua:81

Subtracts the damage from the shipment's health and destroys it at zero health.

Parameters

  • damageInfo

ENT:SetItemTable(uniqueID, batch)

server gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/init.lua:48

Fills the shipment with new instances of an item and sets its model, weight and space.

Uses the item's shipmentModel, or the model_shipment option. Does nothing for an unknown item.

Parameters

  • uniqueID String The unique ID of the item to ship
  • batch Number How many instances to put in the shipment

ENT:SetupDataTables()

shared gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/shared.lua:14

Sets up the networked Index integer holding the shipped item's index.

ENT:Think()

server gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/init.lua:28

Removes the shipment once a second check finds it outside the world.

ENT:UpdateTransmitState()

server gamemodes/catwork/gamemode/core/entities/entities/cw_shipment/init.lua:39

Always transmits the shipment to every client.

Defined in