cw_factory_garbage_paper entity

Entity defined in entities/entities/cw_factory_garbage_paper

Shared definition of the cw_factory_garbage_paper entity, a spawnable garbage recycler that turns paper and cardboard junk items into paper items, with its settings, network vars and think logic.

ENT.GARBAGE_ITEMS lists the accepted items (empty_carton, empty_takeout_carton and empty_cardboard), ENT.METAL_GARBAGE_COUNT_START (4) is the garbage needed for a cycle and ENT.WORK_TIME (30) its length in seconds. ENT:Think absorbs accepted cw_item entities above an idle recycler, each counting twice its weight, drains the count during a cycle and calls ENT:EndWork when the time is up. The single-file cw_factory_garbage_paper.lua next to this folder defines the same class and is loaded after it.

Summary

Methods

CanGarbageUsed(item)server
Returns whether the recycler accepts an item as garbage.
Draw()client
Draws the recycler and its indicator screen with the status, garbage count and progress bars.
Eject()server
Moves the collected garbage into the eject storage entity and empties the recycler.
EndWork()server
Finishes the cycle: stops the work sounds, uses up the collected garbage and spawns a paper item at the product position.
GetSearchPos()server
Returns the corners of the box above the recycler that garbage is collected from.
Initialize()shared
Sets up the recycler model, physics and empty garbage state.
OnRemove()server
Stops the recycler's work sound.
SetupDataTables()shared
Declares the product position, garbage count, working state, work timing, eject storage and stop time network vars.
SpawnFunction(ply, trace)server
Spawns a paper recycler 25 units off the aimed surface.
StartWork()server
Starts a recycling cycle, or resumes a stopped one where it left off.
StopWork()server
Pauses the current cycle, remembering the time left, and stops the work sounds.
Think()shared
Collects garbage, plays the work sounds and advances the recycling cycle every tick on the server.
Use(activator)server
Does nothing; the recycler is operated through its entity menu options.

Methods

ENT:CanGarbageUsed(item)

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:51

Returns whether the recycler accepts an item as garbage.

Parameters

  • item Item The item to check

Returns

  • Boolean Whether the item's unique ID is in ENT.GARBAGE_ITEMS

ENT:Draw()

client gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/cl_init.lua:72

Draws the recycler and its indicator screen with the status, garbage count and progress bars.

While the local player holds the toolgun, a marker also shows the product position.

ENT:Eject()

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:101

Moves the collected garbage into the eject storage entity and empties the recycler.

The storage is found by the creation ID set with SetEjectStorage. Does nothing while working or paused, when the storage does not exist or without the Storage plugin. Items that would push a known container over its weight limit are dropped on top of it instead.

ENT:EndWork()

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:166

Finishes the cycle: stops the work sounds, uses up the collected garbage and spawns a paper item at the product position.

ENT:GetSearchPos()

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:61

Returns the corners of the box above the recycler that garbage is collected from.

Returns

  • List<Vector> The minimum and maximum corners, as passed to ents.FindInBox

ENT:Initialize()

shared gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:13

On the server

Sets up the recycler model, physics and empty garbage state.

On the client

Creates the render target and material for the indicator screen.

Defined in

ENT:OnRemove()

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:190

Stops the recycler's work sound.

ENT:SetupDataTables()

shared gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/shared.lua:39

Declares the product position, garbage count, working state, work timing, eject storage and stop time network vars.

ENT:SpawnFunction(ply, trace)

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:40

Spawns a paper recycler 25 units off the aimed surface.

Parameters

  • ply
  • trace

Returns

  • Entity The spawned recycler

ENT:StartWork()

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:76

Starts a recycling cycle, or resumes a stopped one where it left off.

A new cycle only starts once the garbage count is at least ENT.METAL_GARBAGE_COUNT_START and lasts ENT.WORK_TIME seconds.

ENT:StopWork()

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:149

Pauses the current cycle, remembering the time left, and stops the work sounds.

ENT:Think()

shared gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/shared.lua:53

Collects garbage, plays the work sounds and advances the recycling cycle every tick on the server.

Garbage cw_item entities inside ENT:GetSearchPos are taken while the recycler is idle and not full. During a cycle the garbage count drains step by step and ENT:EndWork runs when the time is up.

ENT:Use(activator)

server gamemodes/cwhl2rp/schema/entities/entities/cw_factory_garbage_paper/init.lua:185

Does nothing; the recycler is operated through its entity menu options.

Parameters

  • activator

Defined in