Security Camera (2.10+) - Revision history

Dragofer: Replaced content with "See Security Camera."

2025-04-19T11:09:48Z

Replaced content with "See Security Camera."

Dragofer at 14:05, 16 July 2022

2022-07-16T14:05:41Z

Dragofer at 13:58, 16 July 2022

2022-07-16T13:58:47Z

Dragofer: Update with new script events.

2022-07-16T13:39:01Z

Update with new script events.

← Older revision		Revision as of 13:39, 16 July 2022
Line 192:		Line 192:
	* getSecurityCameraState() - Returns the security camera's state. 1 = unalerted, 2 = partially alerted, 3 = fully alerted, 4 = inactive (power off), 5 = destroyed, 0 = not a security camera.		* getSecurityCameraState() - Returns the security camera's state. 1 = unalerted, 2 = partially alerted, 3 = fully alerted, 4 = inactive (power off), 5 = destroyed, 0 = not a security camera.
	* getShaderParm(7) - Returns the current value of shaderParm7 on the camera model. 0 = unalerted, 1 = about to resume sweep after a partial alert, 2 = partially alerted, 3 = fully alerted.		* getShaderParm(7) - Returns the current value of shaderParm7 on the camera model. 0 = unalerted, 1 = about to resume sweep after a partial alert, 2 = partially alerted, 3 = fully alerted.
	* ~~activate~~() and ~~trigger~~() - ~~These activate or deactivate~~ the camera ~~fully, representing switching~~ power on or off.		* On() and Off() - Switch the camera's power on or off (note the capitalisation).
			* activate() and trigger() - Toggle the camera's power.
	* getHealth() and setHealth(float newHealth) - As per the name. Setting health to 0 or lower will destroy the security camera, which is irreversible. setHealth() will make an invincible camera vulnerable.		* getHealth() and setHealth(float newHealth) - As per the name. Setting health to 0 or lower will destroy the security camera, which is irreversible. setHealth() will make an invincible camera vulnerable.
	* setSightThreshold() - This changes how lit up the player's lightgem has to be for the security camera to see him, from 0.0 to 1.0.		* setSightThreshold() - This changes how lit up the player's lightgem has to be for the security camera to see him, from 0.0 to 1.0.
			* state_light(boolean set) - Switch the camera's spotlight on/off, if the camera has one.
			* state_sweep(boolean set) - Switch the camera's sweep on/off. This will also affect enemy tracking.
			* state_see_player(boolean set) - Toggle whether the camera is able to detect the player. An alternative is just to set "seePlayer" to "1" or "0", since the code monitors this spawnarg.
	* toggle_light() - Toggle the spotlight on/off, if the camera has one.		* toggle_light() - Toggle the spotlight on/off, if the camera has one.
	* toggle_sweep() - Toggle the camera's sweep on/off. This will also affect ~~following~~.		* toggle_sweep() - Toggle the camera's sweep on/off. This will also affect enemy tracking.
	* toggle_see_player() - Toggle whether the camera is able to detect the player. An alternative is just to set "seePlayer" to "1" or "0", since the code monitors this spawnarg.		* toggle_see_player() - Toggle whether the camera is able to detect the player. An alternative is just to set "seePlayer" to "1" or "0", since the code monitors this spawnarg.

Dragofer: Replace references to "player" with "enemy". Update descriptions of damage behaviour.

2022-07-16T13:33:32Z

Replace references to "player" with "enemy". Update descriptions of damage behaviour.

Show changes

Dragofer at 08:50, 29 January 2022

2022-01-29T08:50:53Z

← Older revision		Revision as of 08:50, 29 January 2022
Line 226:		Line 226:
	==Examining a Test Map==		==Examining a Test Map==

	You can obtain a test map with sample cameras in it here: [~~http~~://ftp.thedarkmod.com/tutorials/RemoteCamera/camerawiki2.pk4 camerawiki2.pk4]. Similar setups can be found as prefabs in AI/Machines.		You can obtain a test map with sample cameras in it here: [https://ftp.thedarkmod.com/tutorials/RemoteCamera/camerawiki2.pk4 camerawiki2.pk4]. Similar setups can be found as prefabs in AI/Machines.

	Open the map ''camerawiki.map'' in Dark Radiant. In this map, we have examples of the different cameras.		Open the map ''camerawiki.map'' in Dark Radiant. In this map, we have examples of the different cameras.

Dragofer at 16:58, 2 March 2021

2021-03-02T16:58:54Z

← Older revision		Revision as of 16:58, 2 March 2021
Line 145:		Line 145:
	===Misc Spawnargs===		===Misc Spawnargs===

	* "~~start_on~~" - Whether the camera starts powered on or off.		* "start_off" - Whether the camera starts powered on or off.
	* "cameraTarget" - Use the view from this entity instead of from self if sending a view to the display screen. See section ''The Display Screen'' for more.		* "cameraTarget" - Use the view from this entity instead of from self if sending a view to the display screen. See section ''The Display Screen'' for more.
	* "gearSpeed" - This spawnarg is set on the ceiling pivot of the 2nd security camera. It controls how fast the gears turn when the security camera turns.		* "gearSpeed" - This spawnarg is set on the ceiling pivot of the 2nd security camera. It controls how fast the gears turn when the security camera turns.

Dragofer at 15:19, 1 March 2021

2021-03-01T15:19:07Z

← Older revision		Revision as of 15:19, 1 March 2021
Line 92:		Line 92:
	===Damage Spawnargs===		===Damage Spawnargs===

	* "health" - Cameras can be 'killed', including by swords, broadhead arrows and fire arrows, but not blackjacks~~. You may protect (parts of) the camera from damage with nodrawsolid brushes, but note that fire arrows only do 30 splash damage, equivalent to 1 broadhead hit~~. Setting to 0 will make the camera invincible.		* "health" - Cameras can be 'killed', including by swords, broadhead arrows and fire arrows, but not blackjacks. Setting to 0 will make the camera invincible. Damage per hit, sword: 42; broadhead: 35; fire arrow direct hit: 400; fire arrow splash: 30.
	* "fx_damage" - Fx to play whenever the camera is damaged while power is on.		* "fx_damage" - Fx to play whenever the camera is damaged while power is on.
	* "fx_damage_nopower" - Fx to play whenever the camera is damaged while power is off.		* "fx_damage_nopower" - Fx to play whenever the camera is damaged while power is off.
Line 175:		Line 175:
	* getShaderParm(7) - Returns the current value of shaderParm7 on the camera model. 0 = unalerted, 1 = about to resume sweep after a partial alert, 2 = partially alerted, 3 = fully alerted.		* getShaderParm(7) - Returns the current value of shaderParm7 on the camera model. 0 = unalerted, 1 = about to resume sweep after a partial alert, 2 = partially alerted, 3 = fully alerted.
	* activate() and trigger() - These activate or deactivate the camera fully, representing switching power on or off.		* activate() and trigger() - These activate or deactivate the camera fully, representing switching power on or off.
	* getHealth() and setHealth(float newHealth) - As per the name. Setting health to 0 or lower will destroy the security camera, which is irreversible.		* getHealth() and setHealth(float newHealth) - As per the name. Setting health to 0 or lower will destroy the security camera, which is irreversible. setHealth() will make an invincible camera vulnerable.
	* setSightThreshold() - This changes how lit up the player's lightgem has to be for the security camera to see him, from 0.0 to 1.0.		* setSightThreshold() - This changes how lit up the player's lightgem has to be for the security camera to see him, from 0.0 to 1.0.
	* toggle_light() - Toggle the spotlight on/off, if the camera has one.		* toggle_light() - Toggle the spotlight on/off, if the camera has one.

Dragofer at 15:25, 24 February 2021

2021-02-24T15:25:00Z

← Older revision		Revision as of 15:25, 24 February 2021
Line 265:		Line 265:
	'''A screen showing the view from another entity (a target_null)'''		'''A screen showing the view from another entity (a target_null)'''

	[[Image:Cw6.jpg\|320px\|thumb\|right\|~~cam3's display~~]]		[[Image:Cw6.jpg\|320px\|thumb\|right\|a small screen showing what a target_null is seeing]]

	This is simply a screen referencing a ''target_null'' as its ''cameraTarget''. The ''target_null'' is in a separate room pointed at a guard.		This is simply a screen referencing a ''target_null'' as its ''cameraTarget''. The ''target_null'' is in a separate room pointed at a guard.

Dragofer at 15:24, 24 February 2021

2021-02-24T15:24:03Z

← Older revision		Revision as of 15:24, 24 February 2021
Line 267:		Line 267:
	[[Image:Cw6.jpg\|320px\|thumb\|right\|cam3's display]]		[[Image:Cw6.jpg\|320px\|thumb\|right\|cam3's display]]

	This is simply a screen referencing a target_null as its cameraTarget. The target_null is in a separate room pointed at a guard.		This is simply a screen referencing a ''target_null'' as its ''cameraTarget''. The ''target_null'' is in a separate room pointed at a guard.

	If you look in the room where the guard is standing, you'll see that the ''target_null'' has the spawnargs ''cameraFovX'' and ''cameraFovY''. These were set because the default field of view for a view from a non-camera entity is 120 by 120, which looks quite zoomed out. For a small screen like this one, 60 by 60 is much better.		If you look in the room where the guard is standing, you'll see that the ''target_null'' has the spawnargs ''cameraFovX'' and ''cameraFovY''. These were set because the default field of view for a view from a non-camera entity is 120 by 120, which looks quite zoomed out. For a small screen like this one, 60 by 60 is much better.

← Older revision		Revision as of 14:05, 16 July 2022
Line 6:		Line 6:

	* It can either sweep back and forth between two angles or remain stationary.		* It can either sweep back and forth between two angles or remain stationary.
	* If the camera sees the player or an AI on a hostile AI, it ~~initially~~ plays a short alert sound that is silent to nearby guards. If the enemy is still in view several seconds later, an alarm sounds. This alarm will ~~play intermittently~~ for a while, even if the enemy moves out of sight.		* If the camera sees the player, an AI on a hostile team or a body, it plays a short alert sound that is silent to nearby guards. If the enemy or body is still in view several seconds later, an alarm sounds. This alarm will repeat every few seconds for a while, even if the enemy moves out of sight.
	* The camera is able to track its enemy, making it much harder to escape its view.		* The camera is able to track its enemy, making it much harder to escape its view.
	* An optional spotlight that points forward, lighting the area in the direction the camera faces~~. You can instead let the camera use a light you created~~.		* An optional spotlight that points forward, lighting the area in the direction the camera faces.
	* The ability to toggle the camera power on/off by triggering it. ~~Alternatively,~~ the above described subsystems can be toggled individually.		* The ability to toggle the camera power on/off by triggering it. Each of the above described subsystems can be toggled individually.
	* If the camera has targets, these will be activated when the camera is fully alerted. This gives the map author the ability to play a more powerful alarm than the one given off by the camera (or to do a variety of other things.)		* If the camera has targets, these will be activated when the camera is fully alerted. This gives the map author the ability to play a more powerful alarm than the one given off by the camera (or to do a variety of other things.)
	* The camera will sound an alarm if it detects bodies.
	* Sending what it sees to a separate, func_static display screen. Alternatively, it can send what another entity (typically a target_null) sees.		* Sending what it sees to a separate, func_static display screen. Alternatively, it can send what another entity (typically a target_null) sees.

Line 21:		Line 20:
	Place the camera entity in your map, and orient it toward its starting direction. A rotating camera will sweep clockwise, halt a moment, then sweep back counter-clockwise.		Place the camera entity in your map, and orient it toward its starting direction. A rotating camera will sweep clockwise, halt a moment, then sweep back counter-clockwise.

	Some cameras may be designed to use additional parts, i.e. a ceiling pivot entity with scripted gears. See the entity descriptions ~~inside DR~~ for more.		Some cameras may be designed to use additional parts, i.e. a ceiling pivot entity with scripted gears. See the prefabs or the entity descriptions for more info.


Line 31:		Line 30:
	* "sweepSpeed" - Horizontal rotation speed in degrees per second.		* "sweepSpeed" - Horizontal rotation speed in degrees per second.
	* "sweepAngle" - The number of degrees the camera covers during its sweep. You can cause a camera to initially sweep in the counter-clockwise direction by setting this to a negative number.		* "sweepAngle" - The number of degrees the camera covers during its sweep. You can cause a camera to initially sweep in the counter-clockwise direction by setting this to a negative number.
	* "sweepWait" - How long the pause is after a ~~sweep completes and starting the return~~ sweep. Default is 0.5 seconds.		* "sweepWait" - How long the pause is after the end of a sweep. Default is 0.5 seconds.
	* "sweepWaitSoundOffset" - Start playing snd_end before the camera reaches the end of its sweep, by this amount of seconds.		* "sweepWaitSoundOffset" - Start playing snd_end before the camera reaches the end of its sweep, by this amount of seconds.

Line 37:		Line 36:
	===Detection Spawnargs===		===Detection Spawnargs===

	These spawnargs govern how the security camera detects and reacts to ~~the player~~: ~~up to what~~ distance, at what light intensity, how long the alarm lasts, whether to trigger anything and so on.		These spawnargs govern how the security camera detects and reacts to enemies: max detection distance, at what light intensity, how long the alarm lasts, whether to trigger anything and so on.

	* "scanDist" - The distance limit for spotting the enemy.		* "scanDist" - The distance limit for spotting the enemy.
	* "scanFov" - The camera's field of view.		* "scanFov" - The camera's field of view.
	* "seePlayer" - Whether the camera will react to the player.		* "seePlayer" - Whether the camera will react to the player.
	* "seeAI" - Whether the camera will react to AIs.		* "seeAI" - Whether the camera will react to AIs, and what their relationship to the camera's team has to be.
	* "seeBodies" - Whether the camera will react to bodies.		* "seeBodies" - Whether the camera will react to bodies.
	* "seeAnimals" - Whether the camera will react to animals.		* "seeAnimals" - Whether the camera will react to animals.
Line 70:		Line 69:
	===Spotlight Spawnargs===		===Spotlight Spawnargs===

	If "spotLight" is set to 1, the security camera's code will spawn a spotlight and align it with its view. This dates back to the ~~Doom3~~ days, so it follows different rules from the def_attach systems. If "useColors" is enabled, the spotlight's color will change depending on alert state. Otherwise it will look for a "_color" spawnarg on the camera.		If "spotLight" is set to 1, the security camera's code will spawn a spotlight and align it with its view. This dates back to the Doom 3 days, so it follows different rules from the def_attach systems. If "useColors" is enabled, the spotlight's color will change depending on alert state. Otherwise it will look for a "_color" spawnarg on the camera.

	Alternatively you can specify an existing light with the spawnarg "spotlight_custom". Apart from "spotLight" and "useColors", all other spotlight-relevant spawnargs are ignored. If no valid entity of spawnclass idLight is found, it'll spawn a spotlight instead.		Alternatively you can specify an existing light with the spawnarg "spotlight_custom". Apart from "spotLight" and "useColors", all other spotlight-relevant spawnargs are ignored. If no valid entity of spawnclass idLight is found, it'll spawn a spotlight instead.

← Older revision		Revision as of 13:58, 16 July 2022
Line 32:		Line 32:
	* "sweepAngle" - The number of degrees the camera covers during its sweep. You can cause a camera to initially sweep in the counter-clockwise direction by setting this to a negative number.		* "sweepAngle" - The number of degrees the camera covers during its sweep. You can cause a camera to initially sweep in the counter-clockwise direction by setting this to a negative number.
	* "sweepWait" - How long the pause is after a sweep completes and starting the return sweep. Default is 0.5 seconds.		* "sweepWait" - How long the pause is after a sweep completes and starting the return sweep. Default is 0.5 seconds.
			* "sweepWaitSoundOffset" - Start playing snd_end before the camera reaches the end of its sweep, by this amount of seconds.


Line 63:		Line 64:
	* "follow_incline_tolerance" - How far in degrees the enemy has to move before the camera readjusts its rotation, vertically.		* "follow_incline_tolerance" - How far in degrees the enemy has to move before the camera readjusts its rotation, vertically.
	* "follow_incline_speed" - Speed of vertical movements to track the enemy. Not affected by 'follow_speed_mult'.		* "follow_incline_speed" - Speed of vertical movements to track the enemy. Not affected by 'follow_speed_mult'.
	* "~~follow_incline_max_up~~" - Limit how far the camera can turn upwards from its starting orientation.		* "follow_constrain_up" - Limit how far the camera can turn upwards from its starting orientation.
	* "~~follow_incline_max_down~~" - Limit how far the camera can turn downwards from its starting orientation.		* "follow_constrain_down" - Limit how far the camera can turn downwards from its starting orientation.


Line 77:		Line 78:
	* "spotlight_diameter" - Diameter of the spotlight's projection. If 0, will automatically be calculated to match spotlight_range and scanFov, for scanFov up to 90°.		* "spotlight_diameter" - Diameter of the spotlight's projection. If 0, will automatically be calculated to match spotlight_range and scanFov, for scanFov up to 90°.
	* "spotlight_texture" - Texture used by the spotlight. You should use a texture that's designed for projected lights: one that uses a gradient as its falloff image. This ensures that light intensity gradually fades to black, rather than abruptly cutting to black.		* "spotlight_texture" - Texture used by the spotlight. You should use a texture that's designed for projected lights: one that uses a gradient as its falloff image. This ensures that light intensity gradually fades to black, rather than abruptly cutting to black.
			* "spotlight_volumetric" - The spawned spotlight will be volumetric.


Line 137:		Line 139:
	* "sparks_particle" - Particle that is spawned.		* "sparks_particle" - Particle that is spawned.
	* "sparks_delay" - Time taken for the particle emitter to spawn initially.		* "sparks_delay" - Time taken for the particle emitter to spawn initially.
	* "sparks_power_dependent" - Only show the particle if power to the ~~(dead)~~ camera is on.		* "sparks_power_dependent" - Only show the particle if power to the destroyed camera is on.
	* "sparks_periodic" - Set to '0' if you use a looping particle and sound. For single-cycle particles and sounds, set to '1' so that they are regularly triggered.
	* "sparks_interval" - For non-looping particles, minimum time between triggers.		* "sparks_interval" - For non-looping particles, minimum time between triggers.
	* "sparks_interval_rand" - For non-looping particles, additional random factor added to the time between triggers.		* "sparks_interval_rand" - For non-looping particles, additional random factor added to the time between triggers.
Line 148:		Line 149:

	* "broken" - Use this model when the camera is destroyed.		* "broken" - Use this model when the camera is destroyed.
	* "clipmodel" - Assign a simplified collision mesh to this camera. Should be under 32 tris (as of TDM 2.10), have only convex angles and use textures/common/collision.
	* "viewOffset" - A vector that defines the offset of the camera's 'eye' from the camera's origin.		* "viewOffset" - A vector that defines the offset of the camera's 'eye' from the camera's origin.
	* "lightOffset" - A vector that defines the spotlight offset from the camera's origin.		* "lightOffset" - A vector that defines the spotlight offset from the camera's origin.
Line 164:		Line 164:
	* "cameraTarget" - Use the view from this entity instead of from self if sending a view to the display screen. See section ''The Display Screen'' for more.		* "cameraTarget" - Use the view from this entity instead of from self if sending a view to the display screen. See section ''The Display Screen'' for more.
	* "gearSpeed" - This spawnarg is set on the ceiling pivot of the 2nd type of security camera. It controls how fast the gears turn when the security camera turns.		* "gearSpeed" - This spawnarg is set on the ceiling pivot of the 2nd type of security camera. It controls how fast the gears turn when the security camera turns.
			* "legacy" - This marks an old version of the security camera, for backwards compatibility with older missions.

	The security camera uses spawnargs to place its 'eye' and spotlight in front of the model to ensure the view and spotlight aren't blocked by the model. If you use a different model, you might need to change these.		The security camera uses spawnargs to place its 'eye' and spotlight in front of the model to ensure the view and spotlight aren't blocked by the model. If you use a different model, you might need to change these.
Line 195:		Line 196:
	* activate() and trigger() - Toggle the camera's power.		* activate() and trigger() - Toggle the camera's power.
	* getHealth() and setHealth(float newHealth) - As per the name. Setting health to 0 or lower will destroy the security camera, which is irreversible. setHealth() will make an invincible camera vulnerable.		* getHealth() and setHealth(float newHealth) - As per the name. Setting health to 0 or lower will destroy the security camera, which is irreversible. setHealth() will make an invincible camera vulnerable.
			* getEnemy() - Returns the entity that most recently caused or refreshed the security camera's suspicious or alert state.
			* canSee() - Tests whether the security camera is able to see a specific entity. Currently only player1 is supported.
	* setSightThreshold() - This changes how lit up the player's lightgem has to be for the security camera to see him, from 0.0 to 1.0.		* setSightThreshold() - This changes how lit up the player's lightgem has to be for the security camera to see him, from 0.0 to 1.0.
	* state_light(boolean set) - Switch the camera's spotlight on/off, if the camera has one.		* state_light(boolean set) - Switch the camera's spotlight on/off, if the camera has one.