cwRadSystem plugin

Implements hook ClockworkInitPostEntity

Called after Catwork has loaded the map entities; restores the saved containment zones.

Plays the local player's Geiger counter clicks.

While the player is inside a containment zone, picks a click chance and volume from the networked radLevel and plays a player/geiger sound.

Implements hook GetBars

Called to add HUD bars; adds the gas mask filter bar for Civil Protection.

Parameters

• bars Map The HUD bars being built

Implements hook HalfSecond

Called every half second; finds the players inside containment zones.

Networks every player's inRadArea flag and runs OnPlayerInContainmentArea for each living player with a character who touches a sphere or box zone, or left one less than a second ago, with the strongest radiation level among the zones they are in (0 after leaving).

Called to paint the HUD; shows the zone's radiation per second to Geiger counter holders.

When resistance reduces the absorbed amount, it is shown in brackets after the zone value.

Implements hook ModifyPlayerRadResistance

Called by cwRadSystem:OnPlayerInContainmentArea to adjust a player's radiation resistance.

Adds resistance for radiation-proof clothing, Overwatch, vortigaunts and mechanic forms. Civil Protection drain their cp_filter and other players drain the energy of their equipped gas mask; either grants 93 extra resistance while it has charge left. The remaining charge is networked as the resist_rad integer.

Parameters

• ply Player The player standing in radiation
• rad Number Radiation strength of the zone, per second
• radresist Number The player's base resistance, in percent

Returns

• Number The modified resistance in percent; 100 or more blocks all radiation

Implements hook OnPlayerInContainmentArea

Called every half second while a player stands in a containment zone.

Once per second, reduces rad by the resistance from ModifyPlayerRadResistance and adds the result to the character's radlevel. Networks the zone strength as radLevel and the absorbed amount as radLevelRes for the HUD.

Parameters

• ply Player The player in the zone
• rad Number Strongest radiation level among the zones the player is in

Implements hook OnPlayerRadLevelChanged

Called when a character's radiation level changes; applies radiation sickness.

Boosts the player's attributes negatively under the Radiation boost in five stages (above 149, 299, 449, 599 and 899) and shows the matching sickness message. Below 150 the boosts are removed. Does nothing for players with cwRadSystem:PlayerHasRadImmune.

Parameters

• ply Player The player whose level changed
• newrad Number The new radlevel

Implements hook PlayerDeath

Called when a player dies; clears their radiation level, networked values and timers.

Parameters

• ply Player The player that died

Returns whether a player can read radiation levels.

True for Overwatch, Civil Protection, mechanic forms and holders of the ] flag; otherwise checks for a geiger_counter item in the inventory (the server's copy on the server, the local inventory on the client).

Parameters

• ply Player The player to check

Returns

• Boolean Whether the player has a Geiger counter

Returns whether a player is immune to radiation.

Mutants (the isMutant character data), creature and mechanic forms and vortigaunts are immune.

Parameters

• ply Player The player to check

Returns

• Boolean Whether the player is immune

Returns whether a player is in a non-humanoid creature form.

The pill-form check is commented out, so this currently always returns nil.

Parameters

• ply Player The player to check

Returns

• Boolean Whether the player is a creature; currently always nil

Returns whether a player is in a mechanical Combine form, such as a scanner or turret.

The pill-form check is commented out, so this currently always returns nil.

Parameters

• ply Player The player to check

Returns

• Boolean Whether the player is a machine; currently always nil

Implements hook PlayerRadThink

Called every player think with the character's radiation level; applies its effects.

Above 999 the player takes damage every half second. Above 899 the player has a small chance every think, at most once every 20 seconds, to be knocked out for 5 to 15 seconds.

Parameters

• ply Player The player thinking
• newrad Number The character's accumulated radlevel

Implements hook PlayerRestoreCharacterData

Called when a character's data is restored; fills in missing radiation fields.

Sets radlevel and radresist to 0 and cp_filter to 100 for Civil Protection characters (0 for everyone else) when they are not stored yet.

Parameters

• ply Player The player whose character is loading
• data Character The character data table, modified in place

Implements hook PlayerShouldStaminaRegenerate

Called to check whether a player's stamina regenerates; blocks it above 199 radiation.

Parameters

• player Player The player to check

Returns

• Boolean false to block regeneration, nil to leave the decision to others

Implements hook PlayerThink

Called every player think; runs the radiation hooks for living characters.

Runs OnPlayerRadLevelChanged when radlevel differs from the last seen value and PlayerRadThink every think.

Parameters

• player Player The player thinking
• curTime Number The current time
• infoTable Map The player's info table for this think

hook.Add id: ContainmentArea

No documentation available.

Implements hook PostPlayerSpawn

Called after a player spawns; clears accumulated radiation on a full respawn.

On a spawn that is neither the first nor a light spawn, resets radlevel and radresist to 0 and refills the Civil Protection filter to 100.

Parameters

• player Player The player that spawned
• lightSpawn Boolean Whether this was a light spawn
• changeClass Boolean Whether the player changed class
• firstSpawn Boolean Whether this is the character's first spawn

Implements hook PostSaveData

Called after data is saved; saves the containment zones.

Sends a radiation sickness message to a player's chat, rate limited.

After a message is shown the next one is held back for a random 59 to 257 seconds.

Parameters

• ply Player The player to message
• text String The message text

Called to draw screen effects; draws the Combine overlay and radiation bloom.

Combine players get the binocular overlay (opaque for Overwatch). Above 449 radiation a pulsing bloom grows stronger with the radiation level and with lost health. Players immune to radiation see neither.

Saves the containment zones of the current map to the schema data.

Writes plugins/containment/<map> with each zone's radiation level, sphere centre and radius or box corners.

Called every frame; runs cwRadSystem:GeigerThink when the local player has a Geiger counter.

Runs at most every 0.06 seconds, and only while the player is inside a containment zone.