Camera Tutorial - Revision history

Lou Montana: Text replacement - " ''via'' " to " via "

2025-02-21T10:43:59Z

Text replacement - " ''via'' " to " via "

← Older revision		Revision as of 12:43, 21 February 2025
Line 74:		Line 74:
	== Specific cases ==		== Specific cases ==

	* A camera of bird type (seagull or crowe) '''cannot''' be controlled ''via'' "Prepare" commands - only camSet* ones.		* A camera of bird type (seagull or crowe) '''cannot''' be controlled via "Prepare" commands - only camSet* ones.
	* A camera of bird type is '''always''' committed ([[camCommitted]] will always return [[true]]) even if it is still moving toward its destination.		* A camera of bird type is '''always''' committed ([[camCommitted]] will always return [[true]]) even if it is still moving toward its destination.

Lou Montana: Add PiP info

2022-07-29T18:04:25Z

Add PiP info

← Older revision		Revision as of 20:04, 29 July 2022
Line 53:		Line 53:
	==== With a loading timeout ====		==== With a loading timeout ====
	<sqf>		<sqf>
	_camera camPreload 3; // since Armed Assault - instantly moves the camera once preload or timeout is done.		_camera camPreload 3; // since Armed Assault - instantly moves the camera once preload or timeout is done.
	// tells the game to preload the future field of view. 3 here is a timeout, 0 for infinite timeout		// tells the game to preload the future field of view. 3 here is a timeout, 0 for infinite timeout
	</sqf>		</sqf>
Line 80:		Line 80:
	== Full example ==		== Full example ==

	==~~= Standard example ===~~		{\| class="wikitable"
			! style="width: 50%" \| [[SQF Syntax]]
			! [[SQS Syntax]]
			\|-
			\|
	<sqf>		<sqf>
	private _camera = "camera" camCreate [0, 0, 0];		private _camera = "camera" camCreate [0, 0, 0];
Line 104:		Line 107:
	</sqf>		</sqf>

	~~=== {{ofp}} SQS example ===~~		\|

	<sqs>		<sqs>
	_camera = "camera" camCreate [0, 0, 0]		_camera = "camera" camCreate [0, 0, 0]
	_camera camSetTarget player		_camera camSetTarget player

	_camera camSetRelPos [0, -5, 10]		_camera camSetRelPos [0, -5, 10]
	_camera cameraEffect ["internal", "back"]		_camera cameraEffect ["internal", "back"]
Line 126:		Line 130:
	camDestroy _camera		camDestroy _camera
	</sqs>		</sqs>
			\|}


			== Picture-in-Picture ==

			=== Create Source ===

			The Picture-in-Picture (PiP) RTT (or R2T, Render to Texture) source can be defined at the {{Link\|#Enter the camera}} step; instead of
			<sqf>_camera cameraEffect ["internal", "back"];</sqf>
			use the following to create a PiP source - multiple sources can be
			<sqf>_camera cameraEffect ["internal", "back", "rttName"];</sqf>

			=== Configure PiP Effects ===

			A camera effect is set using [[setPiPEffect]] as such:
			<sqf>"rttName" setPiPEffect [2]; // sets thermal imaging</sqf>

			Once all the configuration is done, the PiP texture can be accessed by referencing its name "rttName". For example:
			<sqf>
			if (!isPiPEnabled) exitWith { systemChat "PiP is not enabled in video options"; };

			with uiNamespace do // or use disableSerialization
			{
			private _ctrl = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscPicture", -1];
			_ctrl ctrlSetPosition [safeZoneW * 0.75, safeZoneY, safeZoneW * 0.25, safeZoneH * 0.25];
			_ctrl ctrlSetText "#(argb,512,512,1)r2t(rttName,1.0)";
			_ctrl ctrlCommit 0;
			};
			</sqf>

			In order to stop the camera from "broadcasting", use
			<sqf>
			_camera cameraEffect ["terminate", "back", "rttName"]; // terminates "rttName" r2t source
			_camera cameraEffect ["terminate", "back"]; // terminates all r2t source
			</sqf>

			The camera still exists until destroyed with [[camDestroy]].


Line 132:		Line 173:
	* [[Camera.sqs]]		* [[Camera.sqs]]
	* [[Arma 3: Splendid Camera]] / [[BIS_fnc_camera]]		* [[Arma 3: Splendid Camera]] / [[BIS_fnc_camera]]
			* [[:Category:Command Group: Camera Control\|Command Group: Camera Control]]
			* [[BIS_fnc_PIP]]


	[[Category:Arma Scripting Tutorials]]		[[Category:Arma Scripting Tutorials]]

Lou Montana: Some wiki formatting

2022-07-22T10:44:55Z

Some wiki formatting

Show changes

Lou Montana: Some wiki formatting

2021-11-22T18:19:38Z

Some wiki formatting

← Older revision		Revision as of 20:19, 22 November 2021
Line 50:		Line 50:

	==== With a loading timeout ====		==== With a loading timeout ====
	_camera '''[[camPreload]]''' 3; {{cc\|since {{arma1}} - instantly moves the camera once preload or timeout is done.}}		_camera '''[[camPreload]]''' 3; {{cc\|since {{arma1}} - instantly moves the camera once preload or timeout is done.}}
	{{cc\|tells the game to preload the future field of view. '''3''' here is a timeout, 0 for infinite timeout}}		{{cc\|tells the game to preload the future field of view. '''3''' here is a timeout, 0 for infinite timeout}}

Line 118:		Line 118:
	_camera [[cameraEffect]] ["terminate", "back"]		_camera [[cameraEffect]] ["terminate", "back"]
	[[camDestroy]] _camera		[[camDestroy]] _camera


	== See also ==		== See also ==

Lou Montana: Add prepare/set description

2021-07-18T19:12:17Z

Add prepare/set description

← Older revision		Revision as of 21:12, 18 July 2021
Line 11:		Line 11:

	{{Feature\|important\|		{{Feature\|important\|
	The "Prepare" version of camera commands		The "Prepare" version of camera commands has been introduced with {{arma1}}. Using this set of commands helps the engine preloading the camera's (future) field of view (see also [[preloadCamera]]).<br><!--
	In '''{{ofp}}''' the "~~Prepare~~" commands ~~do not exist.<br>~~		-->'''{{ofp}}''' only features the "Set" version of camera commands; use them instead (e.g [[camPreparePos]] becomes [[camSetPos]], [[camCommitPrepared]] becomes [[camCommit]], etc).<br><!--
	~~Use their "normal" counterpart~~ instead (e.g [[camPreparePos]] → [[camSetPos]], [[camCommitPrepared]] → [[camCommit]]).<br>		-->Only [[camCommitted]] is common to both syntaxes.}}
	Only [[camCommitted]] is common to both ~~writings~~.}}

	=== Create the camera ===		=== Create the camera ===

Lou Montana: add camPreload and minor fixes

2021-07-18T19:08:36Z

add camPreload and minor fixes

← Older revision		Revision as of 21:08, 18 July 2021
Line 10:		Line 10:
	The list of all camera commands can be found in the [[:Category:Command Group: Camera Control\|Camera command group]] category.		The list of all camera commands can be found in the [[:Category:Command Group: Camera Control\|Camera command group]] category.

	{{ Feature \| important \| In '''{{ofp}}''' the "Prepare" commands do not exist.<br>Use their "normal" counterpart instead (e.g [[camPreparePos]] → [[camSetPos]], [[camCommitPrepared]] → [[camCommit]]).<br>Only [[camCommitted]] is common to both writings.}}		{{Feature\|important\|
			The "Prepare" version of camera commands
			In '''{{ofp}}''' the "Prepare" commands do not exist.<br>
			Use their "normal" counterpart instead (e.g [[camPreparePos]] → [[camSetPos]], [[camCommitPrepared]] → [[camCommit]]).<br>
			Only [[camCommitted]] is common to both writings.}}

	=== Create the camera ===		=== Create the camera ===
Line 34:		Line 38:

	==== Relative position ====		==== Relative position ====
			_camera [[camCommitPrepared]] 0; {{cc\|required to apply the [[camPrepareTarget\|prepared target]] first - otherwise a long trip from [0,0,0] is to follow}}
	_camera '''[[camPrepareRelPos]]''' [0,5,0];		_camera '''[[camPrepareRelPos]]''' [0,5,0];

Line 42:		Line 47:
	=== Apply all the changes ===		=== Apply all the changes ===

			==== Immediately or with transition ====
	_camera '''[[camCommitPrepared]]''' 0; {{cc\|0 for immediate change, value in seconds for transition}}		_camera '''[[camCommitPrepared]]''' 0; {{cc\|0 for immediate change, value in seconds for transition}}

			==== With a loading timeout ====
			_camera '''[[camPreload]]''' 3; {{cc\|since {{arma1}} - instantly moves the camera once preload or timeout is done.}}
			{{cc\|tells the game to preload the future field of view. '''3''' here is a timeout, 0 for infinite timeout}}

	=== Check that the commit happened ===		=== Check that the commit happened ===

	[[camCommitted]] _camera;		'''[[camCommitted]]''' _camera; {{cc\|for [[camCommitPrepared]] usage}}

			'''[[camPreloaded]]''' _camera; {{cc\|for [[camPreload]] usage}}

	=== Leave the camera ===		=== Leave the camera ===
Line 54:		Line 66:
	=== Delete the camera ===		=== Delete the camera ===

	[[camDestroy]] _camera;		'''[[camDestroy]]''' _camera;


Line 60:		Line 72:

	* A camera of bird type (seagull or crowe) '''cannot''' be controlled ''via'' "Prepare" commands - only camSet* ones.		* A camera of bird type (seagull or crowe) '''cannot''' be controlled ''via'' "Prepare" commands - only camSet* ones.
	* A camera of bird type is '''always''' [[camCommitted]] even if it is still moving toward its destination.		* A camera of bird type is '''always''' committed ([[camCommitted]] will always return [[true]]) even if it is still moving toward its destination.


Line 69:		Line 81:
	[[private]] _camera = "camera" [[camCreate]] [0, 0, 0];		[[private]] _camera = "camera" [[camCreate]] [0, 0, 0];
	_camera [[camPrepareTarget]] player;		_camera [[camPrepareTarget]] player;
			_camera [[camCommitPrepared]] 0; {{cc\|needed for relative position}}
	_camera [[camPrepareRelPos]] [0, -5, 10];		_camera [[camPrepareRelPos]] [0, -5, 10];
	_camera [[cameraEffect]] ["internal", "back"];		_camera [[cameraEffect]] ["internal", "back"];

Lou Montana: Text replacement - "local" to "local"

2021-06-21T16:13:10Z

Text replacement - "local" to "local"

← Older revision		Revision as of 18:13, 21 June 2021
Line 3:		Line 3:

	A cinematic camera is what is commonly known as a "cutscene"; the player's input are dismissed and events happen during the video.<br>		A cinematic camera is what is commonly known as a "cutscene"; the player's input are dismissed and events happen during the video.<br>
	A camera is '''[[local]]''' to the computer where the script has been called; one player could see a cutscene but still get killed by another player that didn't trigger the video.		A camera is '''[[Multiplayer Scripting#Locality\|local]]''' to the computer where the script has been called; one player could see a cutscene but still get killed by another player that didn't trigger the video.

Lou Montana: Text replacement - "\{\{( )Important( )\|" to "{{$1Feature$2|$2important$2|"

2021-02-07T01:08:04Z

Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|"

← Older revision		Revision as of 03:08, 7 February 2021
Line 10:		Line 10:
	The list of all camera commands can be found in the [[:Category:Command Group: Camera Control\|Camera command group]] category.		The list of all camera commands can be found in the [[:Category:Command Group: Camera Control\|Camera command group]] category.

	{{ ~~Important~~ \| In '''{{ofp}}''' the "Prepare" commands do not exist.<br>Use their "normal" counterpart instead (e.g [[camPreparePos]] → [[camSetPos]], [[camCommitPrepared]] → [[camCommit]]).<br>Only [[camCommitted]] is common to both writings.}}		{{ Feature \| important \| In '''{{ofp}}''' the "Prepare" commands do not exist.<br>Use their "normal" counterpart instead (e.g [[camPreparePos]] → [[camSetPos]], [[camCommitPrepared]] → [[camCommit]]).<br>Only [[camCommitted]] is common to both writings.}}

	=== Create the camera ===		=== Create the camera ===

Lou Montana: revert + fix

2021-01-29T16:17:49Z

revert + fix

← Older revision		Revision as of 18:17, 29 January 2021
Line 23:		Line 23:

	==== Object target ====		==== Object target ====
	_camera '''[[camPrepareTarget]]''' [[player]]; {{cc\| a camera will automatically target the human target's face}}		_camera '''[[camPrepareTarget]]''' [[player]]; {{cc\|a camera will automatically target the human target's face}}

	==== Position target ====		==== Position target ====
	_camera '''[[camPrepareTarget]]''' [[getPosATL]] [[player]];		_camera '''[[camPrepareTarget]]''' [[getPosATL]] [[player]];
Line 37:		Line 38:
	=== Apply camera's Field of View ===		=== Apply camera's Field of View ===

	_camera '''[[camPrepareFOV]]''' 0.5; {{cc\| standard FOV is 0.7; lesser (e.g 0.5) is zoomed in, greater (e.g 0.9) is zoomed out}}		_camera '''[[camPrepareFOV]]''' 0.5; {{cc\|standard FOV is 0.7; lesser (e.g 0.5) is zoomed in, greater (e.g 0.9) is zoomed out}}

	=== Apply all the changes ===		=== Apply all the changes ===

	_camera '''[[camCommitPrepared]]''' 0; {{cc\| 0 for immediate change, value in seconds for transition}}		_camera '''[[camCommitPrepared]]''' 0; {{cc\|0 for immediate change, value in seconds for transition}}

	=== Check that the commit happened ===		=== Check that the commit happened ===

Lou Montana: Text replacement - "\{\{ codecomment \| \/\/ ([^ ]+) *\}\} " to "{{cc|$1}}"

2021-01-29T15:32:27Z

Text replacement - "\{\{ *codecomment *\| *\/\/ *([^ ]+) *\}\} " to "{{cc|$1}}"

← Older revision		Revision as of 17:32, 29 January 2021
Line 23:		Line 23:

	==== Object target ====		==== Object target ====
	_camera '''[[camPrepareTarget]]''' [[player]]; {{~~codecomment~~\|// a camera will automatically target the human target's face}}		_camera '''[[camPrepareTarget]]''' [[player]]; {{cc\| a camera will automatically target the human target's face}}

	==== Position target ====		==== Position target ====
	_camera '''[[camPrepareTarget]]''' [[getPosATL]] [[player]];		_camera '''[[camPrepareTarget]]''' [[getPosATL]] [[player]];
Line 38:		Line 37:
	=== Apply camera's Field of View ===		=== Apply camera's Field of View ===

	_camera '''[[camPrepareFOV]]''' 0.5; {{~~codecomment~~\|// standard FOV is 0.7; lesser (e.g 0.5) is zoomed in, greater (e.g 0.9) is zoomed out}}		_camera '''[[camPrepareFOV]]''' 0.5; {{cc\| standard FOV is 0.7; lesser (e.g 0.5) is zoomed in, greater (e.g 0.9) is zoomed out}}

	=== Apply all the changes ===		=== Apply all the changes ===

	_camera '''[[camCommitPrepared]]''' 0; {{~~codecomment~~\|// 0 for immediate change, value in seconds for transition}}		_camera '''[[camCommitPrepared]]''' 0; {{cc\| 0 for immediate change, value in seconds for transition}}

	=== Check that the commit happened ===		=== Check that the commit happened ===

Camera Tutorial - Revision history

Lou Montana: Text replacement - " ''via'' " to " via "

Lou Montana: Add PiP info

Lou Montana: Some wiki formatting

Lou Montana: Some wiki formatting

Lou Montana: Add prepare/set description

Lou Montana: add camPreload and minor fixes

Lou Montana: Text replacement - "local" to "local"

Lou Montana: Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|"

Lou Montana: revert + fix

Lou Montana: Text replacement - "\{\{ *codecomment *\| *\/\/ *([^ ]+) *\}\} " to "{{cc|$1}}"

Lou Montana: Text replacement - "\{\{( )Important( )\|" to "{{$1Feature$2|$2important$2|"

Lou Montana: Text replacement - "\{\{ codecomment \| \/\/ ([^ ]+) *\}\} " to "{{cc|$1}}"