CityRP Documentation Repository

Restraints

Restraints plugin. Owns restraint state: which tool may remove which restraint, and the one release every route goes through. Never exclude it by server or map: the restraint SWEPs and the admin and demotion routes call it by key, unguarded.

RestraintDefinition

3 fields Source ☍
SharedRestraintDefinition.descriptionSource ☍

How it reads in "This person is ...".

SharedRestraintDefinition.idSource ☍

The restraint's identifier, as the tool rules name it.

SharedRestraintDefinition.netvarSource ☍

The NSVar that is true while it is on.

RestraintTool

5 fields Source ☍
SharedRestraintTool.idSource ☍

The tool's identifier, as release routes pass it to CanRelease.

SharedRestraintTool.lawEnforcementRemovesAnySource ☍

Removes any restraint when law enforcement hold it.

SharedRestraintTool.nameSource ☍

How the tool reads in "You need ... to release them".

SharedRestraintTool.removesSource ☍

Restraint ids anyone holding it can remove.

SharedRestraintTool.removesAnySource ☍

Removes any restraint, whoever holds it.