Editor Camera - Revision history

Merlyn: /* Overview */

2017-11-19T04:40:16Z

Overview

← Older revision		Revision as of 21:40, 18 November 2017
Line 2:		Line 2:
	[[Category: Modding]]		[[Category: Modding]]
	[[Category:Overgrowth]]		[[Category:Overgrowth]]
	'''Note''': This documentation mostly applies to '''the editor camera script'''. You can access cameras from other scripts (level scripts, hotspots, character scripts), and may not need to change the editor camera script in order to get the functionality you're looking for!

	The editor camera controller lets you access editor-specific state, so you can set the active camera properties to match. It also lets you respond to special editor-only events like selections, translations, etc, and appropriately freeze camera controls.		The editor camera controller lets you access editor-specific state, so you can set the active camera properties to match. It also lets you respond to special editor-only events like selections, translations, etc, and appropriately freeze camera controls.

			'''Note''': This documentation mostly applies to '''the editor camera script'''. You can access cameras from other scripts (level scripts, hotspots, character scripts), and may not need to change the editor camera script in order to get the functionality you're looking for!

	'''TODO''': Multiple cameras - are those even a thing? How does it work for split-screen?		'''TODO''': Multiple cameras - are those even a thing? How does it work for split-screen?

Merlyn: /* Overview */

2017-11-19T04:40:02Z

Overview

← Older revision		Revision as of 21:40, 18 November 2017
Line 3:		Line 3:
	[[Category:Overgrowth]]		[[Category:Overgrowth]]
	'''Note''': This documentation mostly applies to '''the editor camera script'''. You can access cameras from other scripts (level scripts, hotspots, character scripts), and may not need to change the editor camera script in order to get the functionality you're looking for!		'''Note''': This documentation mostly applies to '''the editor camera script'''. You can access cameras from other scripts (level scripts, hotspots, character scripts), and may not need to change the editor camera script in order to get the functionality you're looking for!

	~~Cameras let you control where the player's view is positioned, what it is pointing at, DOF, etc. Exactly how you'd expect.~~

	The editor camera controller lets you access editor-specific state, so you can set the active camera properties to match. It also lets you respond to special editor-only events like selections, translations, etc, and appropriately freeze camera controls.		The editor camera controller lets you access editor-specific state, so you can set the active camera properties to match. It also lets you respond to special editor-only events like selections, translations, etc, and appropriately freeze camera controls.

Merlyn at 04:38, 19 November 2017

2017-11-19T04:38:56Z

← Older revision		Revision as of 21:38, 18 November 2017
Line 12:		Line 12:
	= Documentation =		= Documentation =

	== Callable functions and data available inside camera ~~scripts~~ ==		== Callable functions and data available inside the editor camera script ==

	The editor camera script gets an instances of the camera itself (a variable defined as <code>Camera@ camera</code>), so it can affect the active camera.		The editor camera script gets an instances of the camera itself (a variable defined as <code>Camera@ camera</code>), so it can affect the active camera.
Line 38:		Line 38:
	The camera object (that actually affects the screen) is exposed to other scripts as instances of the <code>Camera</code> class (as <code>Camera@ camera</code>).		The camera object (that actually affects the screen) is exposed to other scripts as instances of the <code>Camera</code> class (as <code>Camera@ camera</code>).

	= How to create a custom camera script =		= How to create a custom editor camera script =

	The editor camera script always has this path: <code>Data/Scripts/cam.as</code>		The editor camera script always has this path: <code>Data/Scripts/cam.as</code>
Line 44:		Line 44:
	If you are overriding this in a mod, it will have this path: <code>Data/Mods/<your_mod_name>/Scripts/cam.as</code>		If you are overriding this in a mod, it will have this path: <code>Data/Mods/<your_mod_name>/Scripts/cam.as</code>

	= ~~Camera~~ script hook functions =		= Editor camera script hook functions =

	'''All functions inside a camera script are required'''		'''All functions inside the editor camera script are required'''

	* [[#Init function\|<code>void Init() { }</code>]]		* [[#Init function\|<code>void Init() { }</code>]]
Line 56:		Line 56:
	<pre style="white-space: pre-wrap;">void Init() { }</pre>		<pre style="white-space: pre-wrap;">void Init() { }</pre>

	[[#~~Camera~~ script hook functions\|'''Required''']]		[[#Editor camera script hook functions\|'''Required''']]

	<code>Init</code> is called when the camera is first loaded, upon level load.		<code>Init</code> is called when the camera is first loaded, upon level load.
Line 68:		Line 68:
	<pre style="white-space: pre-wrap;">void Update() { }</pre>		<pre style="white-space: pre-wrap;">void Update() { }</pre>

	[[#~~Camera~~ script hook functions\|'''Required''']]		[[#Editor camera script hook functions\|'''Required''']]

	<code>Update</code> is called regularly by the engine so you can perform work.		<code>Update</code> is called regularly by the engine so you can perform work.
Line 74:		Line 74:
	It may be useful to do initialization once in this function, if you need to delay camera updates until other objects have loaded.		It may be useful to do initialization once in this function, if you need to delay camera updates until other objects have loaded.

	Be careful to keep this function short, sweet, and fast. <code>Update</code> gets called 120 times a second as of the time of this writing. '''TODO''': Is this accurate for camera ~~scripts~~?		Be careful to keep this function short, sweet, and fast. <code>Update</code> gets called 120 times a second as of the time of this writing. '''TODO''': Is this accurate for the editor camera script?

	== FrameSelection function ==		== FrameSelection function ==
Line 80:		Line 80:
	<pre style="white-space: pre-wrap;">void FrameSelection(bool increased_distance) { }</pre>		<pre style="white-space: pre-wrap;">void FrameSelection(bool increased_distance) { }</pre>

	[[#~~Camera~~ script hook functions\|'''Required''']]		[[#Editor camera script hook functions\|'''Required''']]

	<code>FrameSelection</code> is called when the "frame selection" action called in editor. This is invoked in one of two ways:		<code>FrameSelection</code> is called when the "frame selection" action called in editor. This is invoked in one of two ways:

Merlyn: /* Callable functions and data available inside camera scripts */

2017-11-19T04:33:07Z

Callable functions and data available inside camera scripts

← Older revision		Revision as of 21:33, 18 November 2017
Line 30:		Line 30:
	* [[Editor_Camera_Script_External_Code\|These functions are unique to the editor camera script]]		* [[Editor_Camera_Script_External_Code\|These functions are unique to the editor camera script]]
	* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''		* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''
	* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from the editor camera script]] - Useful so you can ~~tell~~ the '''code that does not ~~appear~~ in ~~the editor camera~~ script'''.		* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from the editor camera script]] - Useful so you can see the '''code that does not work in this script'''.

	== Camera instances in other scripts ==		== Camera instances in other scripts ==

Merlyn: /* Callable functions and data available inside camera scripts */

2017-11-19T04:32:25Z

Callable functions and data available inside camera scripts

← Older revision		Revision as of 21:32, 18 November 2017
Line 18:		Line 18:
	It also gets an instance of the editor camera controller object (a variable defined as <code>CameraObject@ co</code>), so it can access special camera controller object properties that are applied by the editor.		It also gets an instance of the editor camera controller object (a variable defined as <code>CameraObject@ co</code>), so it can access special camera controller object properties that are applied by the editor.

	A list of functions, data, etc, is created automatically whenever you run the game, in a file on your hard drive. This lists some of the external code you get "for free" and can call from inside a camera script. (<b>Some of this code in this list is not usable from a camera script</b> - see the links below for more info).		A list of functions, data, etc, is created automatically whenever you run the game, in a file on your hard drive. This lists some of the external code you get "for free" and can call from inside the editor camera script. (<b>Some of this code in this list is not usable from an editor camera script</b> - see the links below for more info).

	* '''Windows''': <code>My Documents\Wolfire\Overgrowth\aslevel_docs.h</code>		* '''Windows''': <code>My Documents\Wolfire\Overgrowth\aslevel_docs.h</code>
Line 30:		Line 30:
	* [[Editor_Camera_Script_External_Code\|These functions are unique to the editor camera script]]		* [[Editor_Camera_Script_External_Code\|These functions are unique to the editor camera script]]
	* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''		* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''
	* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from camera ~~scripts~~]] - Useful so you can tell the '''code that does not appear in the editor camera script'''.		* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from the editor camera script]] - Useful so you can tell the '''code that does not appear in the editor camera script'''.

	== Camera instances in other scripts ==		== Camera instances in other scripts ==

Merlyn: /* Callable functions and data available inside camera scripts */

2017-11-19T04:28:43Z

Callable functions and data available inside camera scripts

← Older revision		Revision as of 21:28, 18 November 2017
Line 28:		Line 28:
	There are also wiki pages which have more detailed documentation many of these functions. These pages have a danger of going out of date, but give more detailed documentation on some of the code:		There are also wiki pages which have more detailed documentation many of these functions. These pages have a danger of going out of date, but give more detailed documentation on some of the code:

	* [[Editor_Camera_Script_External_Code\|These functions are unique to editor camera ~~scripts~~]]		* [[Editor_Camera_Script_External_Code\|These functions are unique to the editor camera script]]
	* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''		* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''
	* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from camera scripts]] - ~~This page is useful~~ so you can tell the '''code that does not appear in camera ~~scripts~~'''.		* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from camera scripts]] - Useful so you can tell the '''code that does not appear in the editor camera script'''.

	== Camera instances in other scripts ==		== Camera instances in other scripts ==

Merlyn at 04:27, 19 November 2017

2017-11-19T04:27:22Z

← Older revision		Revision as of 21:27, 18 November 2017
Line 28:		Line 28:
	There are also wiki pages which have more detailed documentation many of these functions. These pages have a danger of going out of date, but give more detailed documentation on some of the code:		There are also wiki pages which have more detailed documentation many of these functions. These pages have a danger of going out of date, but give more detailed documentation on some of the code:

	* [[~~Camera_Script_External_Code~~\|These functions are unique to editor camera scripts]]		* [[Editor_Camera_Script_External_Code\|These functions are unique to editor camera scripts]]
	* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''		* [[Common_Script_External_Code\|These functions are shared with other script types]] - '''Beware, some of this code is only available to other script types! Read the docs carefully!'''
	* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from camera scripts]] - This page is useful so you can tell the '''code that does not appear in camera scripts'''.		* [[Level_Script_External_Code\|These functions are unique to level scripts and cannot be called from camera scripts]] - This page is useful so you can tell the '''code that does not appear in camera scripts'''.

Merlyn: moved Cameras to Editor Camera

2017-11-19T04:26:42Z

moved Cameras to Editor Camera

← Older revision		Revision as of 21:26, 18 November 2017
(No difference)

Merlyn: /* Overview */

2017-11-19T04:24:44Z

Overview

← Older revision		Revision as of 21:24, 18 November 2017
Line 6:		Line 6:
	Cameras let you control where the player's view is positioned, what it is pointing at, DOF, etc. Exactly how you'd expect.		Cameras let you control where the player's view is positioned, what it is pointing at, DOF, etc. Exactly how you'd expect.

	The editor camera controller lets you access editor-specific state, so you can set the ~~correct~~ active camera properties to match. It also lets you respond to special editor-only events like selections, translations, etc, and appropriately freeze camera controls.		The editor camera controller lets you access editor-specific state, so you can set the active camera properties to match. It also lets you respond to special editor-only events like selections, translations, etc, and appropriately freeze camera controls.

	'''TODO''': Multiple cameras - are those even a thing? How does it work for split-screen?		'''TODO''': Multiple cameras - are those even a thing? How does it work for split-screen?

Merlyn: /* Overview */

2017-11-19T04:24:22Z

Overview

← Older revision		Revision as of 21:24, 18 November 2017
Line 6:		Line 6:
	Cameras let you control where the player's view is positioned, what it is pointing at, DOF, etc. Exactly how you'd expect.		Cameras let you control where the player's view is positioned, what it is pointing at, DOF, etc. Exactly how you'd expect.

	The editor camera controller lets you access editor-specific state~~, and access the editor's camera controller~~, so you can set the correct active camera properties to match.		The editor camera controller lets you access editor-specific state, so you can set the correct active camera properties to match. It also lets you respond to special editor-only events like selections, translations, etc, and appropriately freeze camera controls.

	'''TODO''': Multiple cameras - are those even a thing? How does it work for split-screen?		'''TODO''': Multiple cameras - are those even a thing? How does it work for split-screen?