Checkpoints - Revision history

Edoantonioco: /* Using the checkpoint system */

2018-03-30T22:40:15Z

Using the checkpoint system

← Older revision		Revision as of 15:40, 30 March 2018
Line 11:		Line 11:
	Start by creating a new level, or opening an existing level, and activating the editor by hitting <kbd>'''F1'''</kbd>.		Start by creating a new level, or opening an existing level, and activating the editor by hitting <kbd>'''F1'''</kbd>.

	You might want to enable the debug window <code>'''~~Settings~~ → ~~Debug → Draw In-Game~~ Debug Window'''</code> so you can see which is the current checkpoint, shown as <code>'''progress: #'''</code>.		You might want to enable the debug window <code>'''Windows → Debug Window'''</code> so you can see which is the current checkpoint, shown as <code>'''progress: #'''</code>.

	'''Debug keys (these will work once a level has checkpoints):'''		'''Debug keys (these will work once a level has checkpoints):'''

Mng: /* Pre/post goal actions / Added "music_layer_override action"; Added '''Instructions:''' to all actions / Pre/post goal actions table */ Added link to "music_layer_override action"; Edited table contents.

2018-03-13T15:18:38Z

Pre/post goal actions: Added "music_layer_override action"; Added '''Instructions:''' to all actions Pre/post goal actions table: Added link to "music_layer_override action"; Edited table contents.

← Older revision		Revision as of 08:18, 13 March 2018
Line 134:		Line 134:
	\|-		\|-
	\|[[#dialogue_fade_.26_dialogue_fade_if_not_hostile_actions\|dialogue_fade_if_not_hostile]]		\|[[#dialogue_fade_.26_dialogue_fade_if_not_hostile_actions\|dialogue_fade_if_not_hostile]]
	\|same as <code>'''dialogue_fade'''</code> action but the dialogue is not triggered at all if you're currently still in combat. Useful to prevent enemys from attacking the player while in dialogue.		\|same as <code>'''dialogue_fade'''</code> action but the dialogue is not triggered at all if you're currently still in combat. Useful to prevent enemys from attacking the player while in dialogue
	\|-		\|-
	\|[[#play_success_sting_action\|play_success_sting]]		\|[[#play_success_sting_action\|play_success_sting]]
	\|play the success music track, since this was a particularly challenging goal. Usually done on a <code>'''goal_N_post'''</code> action		\|play the success music track, since this was a particularly challenging goal. Usually done on a <code>'''goal_N_post'''</code> action
	\|-		\|-
	\|music_layer_override		\|[[#music_layer_override_action\|music_layer_override]]
	\|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)		\|force play of the given music track layer
	\|}		\|}

Line 150:		Line 150:

	You can combine this with other actions.		You can combine this with other actions.

			'''Instructions:'''

	# Add an NPC to the level (friend or enemy)		# Add an NPC to the level (friend or enemy)
Line 165:		Line 167:

	You can combine these with other actions.		You can combine these with other actions.

			'''Instructions:'''

	# Spawn an object to the level (any kind)		# Spawn an object to the level (any kind)
Line 201:		Line 205:
	You can combine this with other actions.		You can combine this with other actions.

	'''Instructions''':		'''Instructions:'''

	# Set up the goal that you want this action to be triggered by		# Set up the goal that you want this action to be triggered by
	# Add a <code>'''goal_<number>_post'''</code> parameter to the overgrowth_level hotspot for the goal you want to add the success sting to and set the value to <code>'''play_success_sting'''</code>.		# Add a <code>'''goal_<number>_post'''</code> parameter to the overgrowth_level hotspot for the goal you want to add the success sting to and set the value to <code>'''play_success_sting'''</code>.

			=== music_layer_override action ===

			With this action you can set the music layer, tell the game to decide the layer based on activity in the level (is the player in combat or not?) or mute the music.

			'''Note:''' You can't change the music track specified with the <code>music</code> script parameter in the overgrowth_level hotspot with this acton unless you add layers to a given track. '''TODO: Should this be written here?'''

			You can combine this with other actions.

			'''possible <code>music_layer_override <layer></code> values:'''
			{\| class = wikitable
			!0, 1, 2, 3, 4
			\| Sets the music layer (higher means more intense)
			\|-
			! -1
			\| Tells the game to set the music layer based on activity in the level
			\|-
			! -2
			\| Mutes the music
			\|}

			'''Instructions:'''

			# Set up the goal that you want this action to be triggered by
			# Add a <code>'''goal_<number>_<post or pre>'''</code> parameter to the overgrowth_level hotspot for the goal you want to add the success sting to and set the value to <code>'''music_layer_override <layer>'''</code>, where <code>'''<layer>'''</code> is the number of the music layer you want to be played (see table above).

	== Troubleshooting ==		== Troubleshooting ==

Mng: /* dialogue action */ Edited layout.

2018-03-13T14:15:49Z

dialogue action: Edited layout.

← Older revision		Revision as of 07:15, 13 March 2018
Line 190:		Line 190:

	==== dialogue_fade & dialogue_fade_if_not_hostile actions====		==== dialogue_fade & dialogue_fade_if_not_hostile actions====
	~~'''Instructions:'''~~

	Do all the same steps as for the [[#dialogue_action\|dialogue action]], but add <code>'''dialogue_fade'''</code> or <code>'''dialogue_fade_if_not_hostile'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue'''</code>.		Do all the same steps as for the [[#dialogue_action\|dialogue action]], but at step 3 add <code>'''dialogue_fade <dialoguename>'''</code> or <code>'''dialogue_fade_if_not_hostile <dialoguename>'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue <dialoguename>'''</code>.

	===play_success_sting action===		===play_success_sting action===

Mng: /* Goals Table, no_delay modifier */ Removed " Useful in combination with the play_success_sting action."; Added " TODO: How/when is this useful?"

2018-03-13T14:12:03Z

Goals Table, no_delay modifier: Removed " Useful in combination with the play_success_sting action."; Added " TODO: How/when is this useful?"

← Older revision		Revision as of 07:12, 13 March 2018
Line 56:		Line 56:
	\|-		\|-
	\|[[#no_delay_modifier\|no_delay]]		\|[[#no_delay_modifier\|no_delay]]
	\|this is a modifier that reduces the time of the current goal_post or next goal_pre being triggered~~. Useful in combination with the [[#play_success_sting\|play_success_sting]] action~~.		\|this is a modifier that reduces the time of the current goal_post or next goal_pre being triggered.
	\|}		\|}

Line 96:		Line 96:

	=== no_delay modifier ===		=== no_delay modifier ===
	Removes some of the delay between when an objective is completed and when the next step is started.		Removes some of the delay between when an objective is completed and when the next step is started. '''TODO: How/when is this useful?'''

	# Add a <code>'''goal_<number>'''</code> action to the overgrowth_level hotspot		# Add a <code>'''goal_<number>'''</code> action to the overgrowth_level hotspot

Mng: /* dialogue_fade & dialogue_fade_if_not_hostile actions */ Edited Link

2018-03-13T14:03:44Z

dialogue_fade & dialogue_fade_if_not_hostile actions: Edited Link

← Older revision		Revision as of 07:03, 13 March 2018
Line 192:		Line 192:
	'''Instructions:'''		'''Instructions:'''

	Do all the same steps as for the [[~~Checkpoints~~#dialogue_action\|dialogue action]], but add <code>'''dialogue_fade'''</code> or <code>'''dialogue_fade_if_not_hostile'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue'''</code>.		Do all the same steps as for the [[#dialogue_action\|dialogue action]], but add <code>'''dialogue_fade'''</code> or <code>'''dialogue_fade_if_not_hostile'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue'''</code>.

	===play_success_sting action===		===play_success_sting action===

Mng: /* Pre/post goal actions table */ Added links to "dialogue_fade & dialogue_fade_if_not_hostile action"

2018-03-13T14:03:02Z

Pre/post goal actions table: Added links to "dialogue_fade & dialogue_fade_if_not_hostile action"

← Older revision		Revision as of 07:03, 13 March 2018
Line 130:		Line 130:
	\|play a dialogue with the given dialogue name		\|play a dialogue with the given dialogue name
	\|-		\|-
	\|dialogue_fade		\|[[#dialogue_fade_.26_dialogue_fade_if_not_hostile_actions\|dialogue_fade]]
	\|same as <code>'''dialogue'''</code> action but the dialogue is faded in/out at the beginning and end (except on reset). Useful to make dialogue "teleportation" feel less jarring		\|same as <code>'''dialogue'''</code> action but the dialogue is faded in/out at the beginning and end (except on reset). Useful to make dialogue "teleportation" feel less jarring
	\|-		\|-
	\|dialogue_fade_if_not_hostile		\|[[#dialogue_fade_.26_dialogue_fade_if_not_hostile_actions\|dialogue_fade_if_not_hostile]]
	\|same as <code>'''dialogue_fade'''</code> action but the dialogue is not triggered at all if you're currently still in combat. Useful to prevent enemys from attacking the player while in dialogue.		\|same as <code>'''dialogue_fade'''</code> action but the dialogue is not triggered at all if you're currently still in combat. Useful to prevent enemys from attacking the player while in dialogue.
	\|-		\|-

Mng: /* dialogue action */ Added dialogue_fade & dialogue_fade_if_not_hostile actions reference; Edited dialogue action note

2018-03-13T13:59:01Z

dialogue action: Added dialogue_fade & dialogue_fade_if_not_hostile actions reference; Edited dialogue action note

← Older revision		Revision as of 06:59, 13 March 2018
Line 175:		Line 175:
	This action is useful for both <code>'''goal_<number>_pre'''</code> and <code>'''goal_<number>_post'''</code> actions, so you can activate dialogues both to describe a goal when you get to it, and when a goal is completed.		This action is useful for both <code>'''goal_<number>_pre'''</code> and <code>'''goal_<number>_post'''</code> actions, so you can activate dialogues both to describe a goal when you get to it, and when a goal is completed.

	Note ~~that for~~ a <code>'''goal_<goalnumber>_pre'''</code> action, the dialogue will be started again if you die and respawn. The player will also be placed wherever the dialogue placed them, rather than at their spawn point.		'''Note:''' For a <code>'''goal_<goalnumber>_pre'''</code> action, the last two lines of dialogue will be started again if you die and respawn. The player will also be placed wherever the dialogue placed them, rather than at their spawn point.

	You can combine this with other actions.		You can combine this with other actions.

	'''Instructions''':		'''Instructions:'''

	# Add a dialogue to the level and get it working with the dialogue editor. Note that the dialogue can affect the player's spawn point, so put the character where you want them to be after the dialogue finishes		# Add a dialogue to the level and get it working with the dialogue editor. Note that the dialogue can affect the player's spawn point, so put the character where you want them to be after the dialogue finishes
Line 188:		Line 188:

	Do all the same as a dialogue triggered before progressing to a given checkpoint, but name the parameter <code>'''goal_<number>_post'''</code> (e.g. <code>'''goal_5_post'''</code>)		Do all the same as a dialogue triggered before progressing to a given checkpoint, but name the parameter <code>'''goal_<number>_post'''</code> (e.g. <code>'''goal_5_post'''</code>)

			==== dialogue_fade & dialogue_fade_if_not_hostile actions====
			'''Instructions:'''

			Do all the same steps as for the [[Checkpoints#dialogue_action\|dialogue action]], but add <code>'''dialogue_fade'''</code> or <code>'''dialogue_fade_if_not_hostile'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue'''</code>.

	===play_success_sting action===		===play_success_sting action===

Silverfish: /* play_success_sting action */ Fixed todo and minor changes

2018-03-12T11:02:26Z

play_success_sting action: Fixed todo and minor changes

← Older revision		Revision as of 04:02, 12 March 2018
Line 200:		Line 200:

	# Set up the goal that you want this action to be triggered by		# Set up the goal that you want this action to be triggered by
	# Add a <code>'''goal_<~~goalnumber~~>_post'''</code> ~~(or <code>'''goal_<number>_pre'''</code>)~~ parameter to the overgrowth_level hotspot ~~and set~~ the ~~value to <code>'''play_success_sting'''</code>.The goalnumber parameter is~~ goal ~~from step 1 that~~ you want the ~~action~~ to ~~be triggered after (or before)~~		# Add a <code>'''goal_<number>_post'''</code> parameter to the overgrowth_level hotspot for the goal you want to add the success sting to and set the value to <code>'''play_success_sting'''</code>.

	~~'''Note:''' If the success_sting is a <code>'''goal_<goalnumber>_post'''</code> action~~ and the ~~the next~~ <code>'''~~goal_<number>_pre~~'''</code> ~~action is "[[#dialogue_action\|dialogue]]", the [[#no_delay_modifier\|no_delay modifier]] is needed in order to hear it before the dialogue starts. '''TODO: COuldn't confirm this, something's wrong~~. ~~--[[User:Mng\|Mng]] 15:43, 10 March 2018 (UTC)'''~~

	== Troubleshooting ==		== Troubleshooting ==

Silverfish: /* no_delay modifier */ Added explanation

2018-03-12T10:01:54Z

no_delay modifier: Added explanation

← Older revision		Revision as of 03:01, 12 March 2018
Line 96:		Line 96:

	=== no_delay modifier ===		=== no_delay modifier ===
			Removes some of the delay between when an objective is completed and when the next step is started.

	# Add a <code>'''goal_<number>'''</code> action to the overgrowth_level hotspot		# Add a <code>'''goal_<number>'''</code> action to the overgrowth_level hotspot

Silverfish: /* no_delay modifier */ Verified and fixed up

2018-03-12T09:59:52Z

no_delay modifier: Verified and fixed up

← Older revision		Revision as of 02:59, 12 March 2018
Line 97:		Line 97:
	=== no_delay modifier ===		=== no_delay modifier ===

	# Add a <code>'''goal_<number>'''</code> ~~and two corresponding <code>'''goal_<number>_pre/post'''</code> actions~~ to the overgrowth_level hotspot		# Add a <code>'''goal_<number>'''</code> action to the overgrowth_level hotspot
	# Add <code>'''no_delay'''</code> to the <code>'''goal_<number>'''</code> Script Param's value slot, after the specified goal and ~~with~~ a ~~one~~ space ~~wide gap to it '''TODO: COuldn't confirm this sth's wrong --[[User:Mng\|Mng]] 15:45, 10 March 2018 (UTC)'''~~		# Add <code>'''no_delay'''</code> to the <code>'''goal_<number>'''</code> Script Param's value slot, after the specified goal and a space.
	'''Example:'''		'''Example:'''
	{\| class = wikitable		{\| class = wikitable
	! Script Param !! Value		! Script Param !! Value
	\|-		\|-
	~~\|goal_2_pre \|\| dialogue_fade "Stranger"~~		\|goal_2 \|\| defeat 363 '''no_delay'''
	\|-
	\|goal_2 \|\| defeat 363 ~~<span style="font-size:15px">~~'''no_delay'''~~</span>~~
	\|-
	~~\|goal_2_post \|\| play_success_sting~~
	\|}		\|}
	'''Note:''' If you don't specify a <code>'''goal_<number>_post'''</code> action, the modifier will shorten the time to the next <code>'''goal_<number>_pre'''</code> action instead.		'''Note:''' If you don't specify a <code>'''goal_<number>_post'''</code> action, the modifier will shorten the time to the next <code>'''goal_<number>_pre'''</code> action instead.