VisibilityUnit (OpenXcom) - Revision history

Hobbes: Undo revision 126441 by Hobbes (talk)

2026-03-10T14:56:50Z

Undo revision 126441 by Hobbes (talk)

← Older revision		Revision as of 14:56, 10 March 2026
Line 1:		Line 1:
	#~~REDIRECT~~ [[OpenXcom]]		'''Script attached to Armor of the observing unit'''

			Important pre-set local variables of the script hook:

			* '''observer_unit''': The unit currently looking around.
			* '''target_unit''': The unit that could potentially be spotted. If you return a value greater than zero, then this unit has been seen by observer_unit.
			* '''current_visibility''' / '''default_visibility''' (currently always the same value): The currently pre-calculated visibility. For a no-operation script hook you can just return this value and get vanilla behaviour.
			* '''distance''': The adjusted visible distance of the observer_unit. Takes into account smoke.
			* '''distance_max''': The maximum viewing distance of observer_unit in the current environment lighting
			* '''fire_density''': Cumulative fire density in the line of sight over all the voxels.
			* '''smoke_density''': Cumulative smoke density in the line of sight over all the voxels. A grenade has a smoke density of around 15 per tile.
			* '''visibility_mode''' aka BattleUnitVisibility.Tag: Helper tags for script to implement different visibility modes, e.g. camouflage script should affect only normal visibility not infra-red or some other exotic versions.

			Script return values:
			# '''current_visibility''': integer
			# '''visibility_mode''' aka BattleUnitVisibility.Tag: integer

			Source Code script call:
			ModScript::VisibilityUnit::Output arg{ visibilityQuality, visibilityQuality, ScriptTag<BattleUnitVisibility>::getNullTag() };
			ModScript::VisibilityUnit::Worker worker{ currentUnit, tile->getUnit(), visibleDistanceVoxels, visibleDistanceMaxVoxel, densityOfSmoke * smokeDensityFactor / 100, densityOfFire };

			Source Code usage of return values:
			unitSeen = 0 < arg.getFirst();

			=== Description ===

			Gets called to check if one unit from one faction can see another unit from another faction.
			Won’t get called for units in the same faction because they can always see each other.

			Currently (2019-12-24) only the first return value is used by the engine and only in a boolean check.

			If the first return value (current_visibility) is greater than zero (> 0) then the observer unit has seen the target_unit.
			This hook can be used to alter the visibility of a battle unit on the fly. You can take into account the given information and decide for yourself if the unit has been spotted or not.

			[[Category:OpenXcom]]

Hobbes: Protected "VisibilityUnit (OpenXcom)" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2026-03-10T14:01:39Z

Protected "VisibilityUnit (OpenXcom)" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 14:01, 10 March 2026
(No difference)

Hobbes: Redirected page to OpenXcom

2026-03-10T14:00:44Z

Redirected page to OpenXcom

← Older revision		Revision as of 14:00, 10 March 2026
Line 1:		Line 1:
	~~'''Script attached to Armor of the observing unit'''~~		#REDIRECT [[OpenXcom]]

	~~Important pre-set local variables of the script hook:~~

	* '''observer_unit''': The unit currently looking around.
	* '''target_unit''': The unit that could potentially be spotted. If you return a value greater than zero, then this unit has been seen by observer_unit.
	* '''current_visibility''' / '''default_visibility''' (currently always the same value): The currently pre-calculated visibility. For a no-operation script hook you can just return this value and get vanilla behaviour.
	* '''distance''': The adjusted visible distance of the observer_unit. Takes into account smoke.
	* '''distance_max''': The maximum viewing distance of observer_unit in the current environment lighting
	* '''fire_density''': Cumulative fire density in the line of sight over all the voxels.
	* '''smoke_density''': Cumulative smoke density in the line of sight over all the voxels. A grenade has a smoke density of around 15 per tile.
	* '''visibility_mode''' aka BattleUnitVisibility.Tag: Helper tags for script to implement different visibility modes, e.g. camouflage script should affect only normal visibility not infra-red or some other exotic versions.

	~~Script return values:~~
	# ~~'''current_visibility''': integer~~
	~~# '''visibility_mode''' aka BattleUnitVisibility.Tag: integer~~

	~~Source Code script call:~~
	~~ModScript::VisibilityUnit::Output arg{ visibilityQuality, visibilityQuality, ScriptTag<BattleUnitVisibility>::getNullTag() };~~
	~~ModScript::VisibilityUnit::Worker worker{ currentUnit, tile->getUnit(), visibleDistanceVoxels, visibleDistanceMaxVoxel, densityOfSmoke * smokeDensityFactor / 100, densityOfFire };~~

	~~Source Code usage of return values:~~
	~~unitSeen = 0 < arg.getFirst();~~

	~~=== Description ===~~

	~~Gets called to check if one unit from one faction can see another unit from another faction.~~
	~~Won’t get called for units in the same faction because they can always see each other.~~

	~~Currently (2019-12-24) only the first return value is used by the engine and only in a boolean check.~~

	~~If the first return value (current_visibility) is greater than zero (> 0) then the observer unit has seen the target_unit.~~
	~~This hook can be used to alter the visibility of a battle unit on the fly. You can take into account the given information and decide for yourself if the unit has been spotted or not.~~

	[[~~Category:~~OpenXcom]]

Yankes: Add some more info

2020-01-17T20:55:05Z

Add some more info

← Older revision		Revision as of 20:55, 17 January 2020
Line 10:		Line 10:
	* '''fire_density''': Cumulative fire density in the line of sight over all the voxels.		* '''fire_density''': Cumulative fire density in the line of sight over all the voxels.
	* '''smoke_density''': Cumulative smoke density in the line of sight over all the voxels. A grenade has a smoke density of around 15 per tile.		* '''smoke_density''': Cumulative smoke density in the line of sight over all the voxels. A grenade has a smoke density of around 15 per tile.
	* '''visibility_mode''' aka BattleUnitVisibility.Tag: ~~???~~		* '''visibility_mode''' aka BattleUnitVisibility.Tag: Helper tags for script to implement different visibility modes, e.g. camouflage script should affect only normal visibility not infra-red or some other exotic versions.

	Script return values:		Script return values:

Memmaker at 11:20, 27 December 2019

2019-12-27T11:20:45Z

← Older revision		Revision as of 11:20, 27 December 2019
Line 6:		Line 6:
	* '''target_unit''': The unit that could potentially be spotted. If you return a value greater than zero, then this unit has been seen by observer_unit.		* '''target_unit''': The unit that could potentially be spotted. If you return a value greater than zero, then this unit has been seen by observer_unit.
	* '''current_visibility''' / '''default_visibility''' (currently always the same value): The currently pre-calculated visibility. For a no-operation script hook you can just return this value and get vanilla behaviour.		* '''current_visibility''' / '''default_visibility''' (currently always the same value): The currently pre-calculated visibility. For a no-operation script hook you can just return this value and get vanilla behaviour.
	* '''distance''': The distance ~~in voxels between~~ the ~~two units~~		* '''distance''': The adjusted visible distance of the observer_unit. Takes into account smoke.
	* '''distance_max''': The maximum viewing distance of observer_unit in the current environment lighting		* '''distance_max''': The maximum viewing distance of observer_unit in the current environment lighting
	* '''fire_density''': Cumulative fire density in the line of sight over all the voxels.		* '''fire_density''': Cumulative fire density in the line of sight over all the voxels.

Memmaker: Memmaker moved page VisibilityUnit OpenXCom to VisibilityUnit (OpenXcom): Naming conventions

2019-12-24T14:31:46Z

Memmaker moved page VisibilityUnit OpenXCom to VisibilityUnit (OpenXcom): Naming conventions

← Older revision	Revision as of 14:31, 24 December 2019
(No difference)

Memmaker: Corrected category

2019-12-24T14:31:05Z

Corrected category

← Older revision		Revision as of 14:31, 24 December 2019
Line 1:		Line 1:
	~~== visibilityUnit ==~~

	'''Script attached to Armor of the observing unit'''		'''Script attached to Armor of the observing unit'''

Line 35:		Line 33:
	This hook can be used to alter the visibility of a battle unit on the fly. You can take into account the given information and decide for yourself if the unit has been spotted or not.		This hook can be used to alter the visibility of a battle unit on the fly. You can take into account the given information and decide for yourself if the unit has been spotted or not.

			[[Category:OpenXcom]]
	[[Category:~~OpenXCom~~]]

Memmaker: Added category

2019-12-24T14:26:39Z

Added category

← Older revision		Revision as of 14:26, 24 December 2019
Line 34:		Line 34:
	If the first return value (current_visibility) is greater than zero (> 0) then the observer unit has seen the target_unit.		If the first return value (current_visibility) is greater than zero (> 0) then the observer unit has seen the target_unit.
	This hook can be used to alter the visibility of a battle unit on the fly. You can take into account the given information and decide for yourself if the unit has been spotted or not.		This hook can be used to alter the visibility of a battle unit on the fly. You can take into account the given information and decide for yourself if the unit has been spotted or not.


			[[Category:OpenXCom]]

Memmaker: Memmaker moved page VisibilityUnit to VisibilityUnit OpenXCom: Naming conventions

2019-12-24T14:24:32Z

Memmaker moved page VisibilityUnit to VisibilityUnit OpenXCom: Naming conventions

← Older revision	Revision as of 14:24, 24 December 2019
(No difference)

Memmaker at 13:51, 24 December 2019

2019-12-24T13:51:13Z

← Older revision		Revision as of 13:51, 24 December 2019
Line 1:		Line 1:
	== visibilityUnit ==		== visibilityUnit ==

	'''Script attached to Armor'''		'''Script attached to Armor of the observing unit'''

	Important pre-set local variables of the script hook:		Important pre-set local variables of the script hook: