Factory Dispenser entity

Entity defined in plugin/entities/entities/cw_factorydispenser

Part of Ration Factory

Shared definition of the cw_factorydispenser entity of the Ration Factory plugin, with the networked spawn type and GetSpawnType.

Also sets the global TYPE_WATERCAN (0) and TYPE_SUPPLIES (1) constants, which for this entity stand for Breen's Water and citizen supplements.

Originally written for the Iron Wall community.

Summary

Methods

CanTool(player, trace, tool)server
Blocks every toolgun action on the dispenser.
CountProducts()server
Returns how many of the items the dispenser made still exist, forgetting the ones that are gone.
Draw()client
Draws the dispenser's model.
EmitRandomSound()server
Plays one of the dispenser's machine sounds at random.
GetSpawnType()shared
Returns what the dispenser spawns.
Initialize()shared
Sets up the button model, attaches the output pipe and defaults to dispensing supplies.
PhysicsUpdate(physicsObject)server
Keeps the dispenser still unless a player holds it or it is constrained.
SetSpawnType(entType)server
Sets what the dispenser spawns; other values are ignored.
SetupDataTables()shared
Sets up the dispenser's networked index and spawn type.
SpawnItem(activator)server
Spawns the dispenser's item: Breen's Water at the pipe, or citizen supplements at the button.
Think()client
Does nothing on the client.
UpdateTransmitState()server
Makes the dispenser always transmit to clients.
Use(activator, caller)server
Dispenses an item when a player presses the button, with a five second cooldown.

Methods

ENT:CanTool(player, trace, tool)

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:134

Blocks every toolgun action on the dispenser.

Parameters

  • player
  • trace
  • tool

ENT:CountProducts()

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:53

Returns how many of the items the dispenser made still exist, forgetting the ones that are gone.

Returns

  • Number The item count

ENT:Draw()

client gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/cl_init.lua:8

Draws the dispenser's model.

ENT:EmitRandomSound()

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:81

Plays one of the dispenser's machine sounds at random.

ENT:GetSpawnType()

shared gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/shared.lua:29

Returns what the dispenser spawns.

Returns

  • Number TYPE_WATERCAN (0) or TYPE_SUPPLIES (1)

ENT:Initialize()

shared gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:19

On the server

Sets up the button model, attaches the output pipe and defaults to dispensing supplies.

On the client

Does nothing on the client.

Defined in

ENT:PhysicsUpdate(physicsObject)

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:91

Keeps the dispenser still unless a player holds it or it is constrained.

Parameters

  • physicsObject

ENT:SetSpawnType(entType)

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:69

Sets what the dispenser spawns; other values are ignored.

Parameters

  • entType Number TYPE_WATERCAN (0) for breens_water, TYPE_SUPPLIES (1) for citizen_supplements

ENT:SetupDataTables()

shared gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/shared.lua:22

Sets up the dispenser's networked index and spawn type.

ENT:SpawnItem(activator)

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:119

Spawns the dispenser's item: Breen's Water at the pipe, or citizen supplements at the button.

Parameters

  • activator Player The player who pressed the button, passed on as the item's creator

ENT:Think()

client gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/cl_init.lua:17

Does nothing on the client.

ENT:UpdateTransmitState()

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:76

Makes the dispenser always transmit to clients.

ENT:Use(activator, caller)

server gamemodes/cwhl2rp/plugins/rationfactory/plugin/entities/entities/cw_factorydispenser/init.lua:101

Dispenses an item when a player presses the button, with a five second cooldown.

Pressing it during the cooldown, or while 20 of its items still exist, plays a denial sound.

Parameters

  • activator
  • caller

Defined in