Characters - Revision history

Constance: /* Wolf */ Included note about fear parameters

2022-07-12T20:38:46Z

Wolf: Included note about fear parameters

← Older revision		Revision as of 13:38, 12 July 2022
Line 48:		Line 48:
	* Cannot be harmed by unarmed attacks, except from other wolves or leg cannon		* Cannot be harmed by unarmed attacks, except from other wolves or leg cannon
	* Causes all other races controlled by AI except dogs to run away in terror		* Causes all other races controlled by AI except dogs to run away in terror
			** This is configurable in each character's parameters
	* Uses their KO shield as health		* Uses their KO shield as health

Silverfish: Rewrite

2018-02-06T13:53:45Z

Rewrite

@@ Line 1: / Line 1: @@
-''{{about|the engine feature|a list of characters in the Overgrowth universe|Characters (lore)}}''<br>
+''{{about|the engine feature|a list of characters in the Overgrowth universe|Characters (lore)|character scripting|Character Scripting}}''<br>
 [[Category:Modding]]
@@ Line 5: / Line 5: @@
 = Overview =
-Characters are a game entities that are directly controllable by a player or by the AI.
+Every character has a number of script parameters associated with it that can be used to change how its AI behaves, how fast it is, how big it is and other things like that. Read the [[Script_Parameters#Character|Script Prameters]] article for more information.
-'''TODO''': Improve overview
+= Creating a Spawn Point =
-= Getting Started =
+If you press 8 while there is no player-controlled character in the level, the editor will create a Turner character spawn point on the camera and set it to player-controlled before entering play mode.
-'''TODO''': How to set a character as playable in the editor.
+You can set or unset any character as player-controlled, which is covered in the next section.
-'''TODO''': List of supported character parameters and how to use them. Some of these things verge more into "game" territory and not "engine" territory, so should at the very least mention that it's fully changeable in script...
+= Set Player-Controlled Character =
-'''TODO''': List of species specific traits? Some of these things verge more into "game" territory and not "engine" territory, so should at the very least mention that it's fully changeable in script...
+If you want the level to be multiplayer you simply set more spawn points to player-controlled. Up to four spawn points can be player controlled.

Silverfish: Moved a lot of stuff out from this article into "Character Scripting" and "Custom Characters" page

2018-01-31T12:21:09Z

Moved a lot of stuff out from this article into "Character Scripting" and "Custom Characters" page

Show changes

Merlyn: /* WasBlocked function */

2017-12-02T05:39:46Z

WasBlocked function

← Older revision		Revision as of 22:39, 1 December 2017
Line 528:		Line 528:
	Vestigial function not called by the engine or base game scripts. It is exposed to other scripts on the <code>MovementObject@</code> interface, and must be present if it gets called by game scripts.		Vestigial function not called by the engine or base game scripts. It is exposed to other scripts on the <code>MovementObject@</code> interface, and must be present if it gets called by game scripts.

	'''Note''': This might be vaguely useful if you're building a full replacement for combat, but considering it takes no parameters, the [[#WasHit function\|<code>WasHit</code>]] function is flexible enough to support two-pass combat checks and handle blocking, this function might just be entirely unneeded at this point.		'''Note''': This might be vaguely useful if you're building a full replacement for combat, but considering it takes no parameters, and the [[#WasHit function\|<code>WasHit</code>]] function is flexible enough to support two-pass combat checks and handle blocking, this function might just be entirely unneeded at this point.

	== Dispose function ==		== Dispose function ==

Merlyn: /* WasBlocked function */

2017-12-02T05:39:24Z

WasBlocked function

← Older revision		Revision as of 22:39, 1 December 2017
Line 528:		Line 528:
	Vestigial function not called by the engine or base game scripts. It is exposed to other scripts on the <code>MovementObject@</code> interface, and must be present if it gets called by game scripts.		Vestigial function not called by the engine or base game scripts. It is exposed to other scripts on the <code>MovementObject@</code> interface, and must be present if it gets called by game scripts.

	'''Note''': This might be vaguely useful if you're building a full replacement for combat, but considering it takes no parameters, ~~and~~ the [[#WasHit function\|<code>WasHit</code>]] function is flexible enough to support two-pass combat checks, and handle blocking, this function might ~~well~~ be entirely ~~worthless~~ at this point.		'''Note''': This might be vaguely useful if you're building a full replacement for combat, but considering it takes no parameters, the [[#WasHit function\|<code>WasHit</code>]] function is flexible enough to support two-pass combat checks and handle blocking, this function might just be entirely unneeded at this point.

	== Dispose function ==		== Dispose function ==

Merlyn: /* WasBlocked function */

2017-12-02T05:37:21Z

WasBlocked function

← Older revision		Revision as of 22:37, 1 December 2017
Line 528:		Line 528:
	Vestigial function not called by the engine or base game scripts. It is exposed to other scripts on the <code>MovementObject@</code> interface, and must be present if it gets called by game scripts.		Vestigial function not called by the engine or base game scripts. It is exposed to other scripts on the <code>MovementObject@</code> interface, and must be present if it gets called by game scripts.

	'''~~TODO~~''': ~~More details on what to use instead? Does~~ [[#WasHit function\|<code>WasHit~~(...)~~</code>]] handle ~~everything~~ this function ~~would handle?~~		'''Note''': This might be vaguely useful if you're building a full replacement for combat, but considering it takes no parameters, and the [[#WasHit function\|<code>WasHit</code>]] function is flexible enough to support two-pass combat checks, and handle blocking, this function might well be entirely worthless at this point.

	== Dispose function ==		== Dispose function ==

Merlyn: /* PreDrawFrame function */

2017-12-02T04:55:18Z

PreDrawFrame function

← Older revision		Revision as of 21:55, 1 December 2017
Line 437:		Line 437:
	[[#Character script hook functions\|'''Required''']]		[[#Character script hook functions\|'''Required''']]

	[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame ~~calculations~~ before anything in the frame is drawn.		[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame work before anything in the frame is drawn.

	'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.		'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.

Merlyn: /* PreDrawFrame function */

2017-12-02T04:54:25Z

PreDrawFrame function

← Older revision		Revision as of 21:54, 1 December 2017
Line 437:		Line 437:
	[[#Character script hook functions\|'''Required''']]		[[#Character script hook functions\|'''Required''']]

	[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame calculations before anything in the frame is drawn~~, like updating the character's blob shadows~~.		[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame calculations before anything in the frame is drawn.

	'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.		'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.

	'''Note''': Once all objects have had [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] called on them, then the rest of the rendering is done for the frame.		'''Note''': Once all objects have had [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] called on them, then the rest of the rendering is done for the frame.

			In the base scripts, the only thing this is used for right now is to make sure character's blob shadows are hidden if the character gets occluded from the camera.

	== PreDrawCameraNoCull function ==		== PreDrawCameraNoCull function ==

Merlyn: /* PreDrawCamera function */

2017-12-02T04:44:06Z

PreDrawCamera function

← Older revision		Revision as of 21:44, 1 December 2017
Line 467:		Line 467:
	[[#PreDrawCamera function\|<code>PreDrawCamera</code>]] is called for characters in the scene that were not culled out of the view of this camera, in order to perform per-frame, per-camera functions. It is called for each character that didn't get culled immediately after the call to [[#PreDrawCameraNoCull function\|<code>PreDrawCamera</code>]]. Unlike [[#PreDrawCameraNoCull function\|<code>PreDrawCamera</code>]], this function is only called if the character is '''not''' culled by occlusion or frustum culling in this camera's view.		[[#PreDrawCamera function\|<code>PreDrawCamera</code>]] is called for characters in the scene that were not culled out of the view of this camera, in order to perform per-frame, per-camera functions. It is called for each character that didn't get culled immediately after the call to [[#PreDrawCameraNoCull function\|<code>PreDrawCamera</code>]]. Unlike [[#PreDrawCameraNoCull function\|<code>PreDrawCamera</code>]], this function is only called if the character is '''not''' culled by occlusion or frustum culling in this camera's view.

	'''Note''': [[#PreDrawCamera function\|<code>PreDrawCamera</code>]] is called for each player character's camera, for cube map probes ("reflection captures"), for shadow cascades, etc. It may be called more than once per character per frame, since it handles per-camera actions. This is called immediately after [[#PreDrawCameraNoCull function\|<code>PreDrawCameraNoCull</code>]] was completed for the same object, with the same camera, so calls ~~two~~ these two functions ~~get~~ interleaved.		'''Note''': [[#PreDrawCamera function\|<code>PreDrawCamera</code>]] is called for each player character's camera, for cube map probes ("reflection captures"), for shadow cascades, etc. It may be called more than once per character per frame, since it handles per-camera actions. This is called immediately after [[#PreDrawCameraNoCull function\|<code>PreDrawCameraNoCull</code>]] was completed for the same object, with the same camera, so calls to these two functions are interleaved.

	Examples of character-related things this function are useful (in the base scripts) include:		Examples of character-related things this function are useful (in the base scripts) include:

Merlyn: /* PreDrawCameraNoCull function */

2017-12-02T04:43:34Z

PreDrawCameraNoCull function

← Older revision		Revision as of 21:43, 1 December 2017
Line 451:		Line 451:
	[[#PreDrawCameraNoCull function\|<code>PreDrawCameraNoCull</code>]] is called for all objects in the scene, to perform per-frame, per-camera functions. Unliked [[#PreDrawCamera function\|<code>PreDrawCamera</code>]], this function is always called, even if the object is culled by occlusion or frustum culling for this camera.		[[#PreDrawCameraNoCull function\|<code>PreDrawCameraNoCull</code>]] is called for all objects in the scene, to perform per-frame, per-camera functions. Unliked [[#PreDrawCamera function\|<code>PreDrawCamera</code>]], this function is always called, even if the object is culled by occlusion or frustum culling for this camera.

	'''Note''': [[#PreDrawCameraNoCull function\|<code>PreDrawCameraNoCull</code>]] is called for each player character's camera, for cube map probes ("reflection captures"), for shadow cascades, etc. ~~This~~ is ~~called~~ after all calls to [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] have completed.		'''Note''': [[#PreDrawCameraNoCull function\|<code>PreDrawCameraNoCull</code>]] is called for each player character's camera, for cube map probes ("reflection captures"), for shadow cascades, etc. The first call to this function is made after all calls to [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] have completed for all objects.

	Examples of character-related things this function are useful (in the base scripts) include:		Examples of character-related things this function are useful (in the base scripts) include:

← Older revision		Revision as of 21:55, 1 December 2017
Line 437:		Line 437:
	[[#Character script hook functions\|'''Required''']]		[[#Character script hook functions\|'''Required''']]

	[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame ~~calculations~~ before anything in the frame is drawn.		[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame work before anything in the frame is drawn.

	'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.		'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.

← Older revision		Revision as of 21:54, 1 December 2017
Line 437:		Line 437:
	[[#Character script hook functions\|'''Required''']]		[[#Character script hook functions\|'''Required''']]

	[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame calculations before anything in the frame is drawn~~, like updating the character's blob shadows~~.		[[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called to let scripts perform per-frame calculations before anything in the frame is drawn.

	'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.		'''Note''': After [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] is called for this character, then all objects attached to this character are moved to their correct positions.

	'''Note''': Once all objects have had [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] called on them, then the rest of the rendering is done for the frame.		'''Note''': Once all objects have had [[#PreDrawFrame function\|<code>PreDrawFrame</code>]] called on them, then the rest of the rendering is done for the frame.

			In the base scripts, the only thing this is used for right now is to make sure character's blob shadows are hidden if the character gets occluded from the camera.

	== PreDrawCameraNoCull function ==		== PreDrawCameraNoCull function ==