Checkpoints

From Wolfire Games Wiki
(Difference between revisions)
Jump to: navigation, search
(Pre/post goal actions)
m (Pre/post goal actions)
Line 103: Line 103:
 
You can trigger an action to happen, either when a goal is set as the "current" goal, or after a goal has been accomplished.
 
You can trigger an action to happen, either when a goal is set as the "current" goal, or after a goal has been accomplished.
  
Goal actions can be combined with each other. Just put a space between them (e.g. <code>'''activate 537 dialogue ShopkeeperBanter'''</code>).
+
Goal actions can be combined with each other. Just put a space between them (e.g. <code>'''activate 537 dialogue ShopkeeperBanter'''</code>). Make sure to put them in the order you want them to happen (if that's important).
  
 
Here's a list of actions that can be triggered:
 
Here's a list of actions that can be triggered:

Revision as of 05:41, 8 January 2018

Checkpoints allow you to set up goals that the player can achieve to advance progress in a level.

With them you can move the player spawn point upon death and allow defeated enemies to remain dead.

When the player advances progress, you can do nothing, play a dialogue, spawn new enemies, or trigger a level win (load the next level).

You can make some of the checkpoints optional, so player progress is saved, but the player does not have to touch them to complete the level.

TODO: Add some screenshots to make this more clear?

TODO: Add instructions on the remaining goal actions below that aren't yet documented. They should all be listed now though!

Contents

Using the checkpoint system

Start by creating a new level, or opening an existing level, and activating the editor by hitting F1.

You might want to enable debug text (Settings -> Debug -> enable Draw In-Game Debug Window).

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

L reset the level to the currently achieved checkpoint
K swap to the next checkpoint, or wrap around to the first (remember to hit L after to reset)

To add the checkpoint system to a level:

Load -> Load Item... -> Data/Objects/Hotspots/overgrowth_level.xml

After this, set goals, and possibly pre/post goal actions.

Goals

Goals must be accomplished by the player, in order.

Some goals are optional, in which case the player may defeat later goals, and these goals will be considered "accomplished".

The table below shows the types of goals that can be used as checkpoints. Below the table are instructions for how to use each goal.

reach when touched, moves the player spawn point and saves defeated enemies. must touch it to complete the level/advance progress
reach_skippable same as "reach" goal but the player never has to reach it to complete the level/advance progress
defeat the player must defeat a list of enemies to complete the level/advance progress
defeat_optional the player may defeat a list of enemies to advance progress. If a further goal is accomplished first, these enemies are considered "defeated" when the character respawns
spawn_defeat same as "defeat" goal but the enemies to defeat are spawned when that becomes the current goal (or on reset)
no_delay this is a modifier you can put after any defeat goal, to reduce the time to the current goal_post or next goal_pre being triggered

reach goal

  1. Add the checkpoint hotspot to the scene. This is the trigger for the checkpoint. Load -> Load Item... -> Data/Objects/Hotspots/overgrowth_level_checkpoint.xml
  2. Add the placeholder object to the scene. This is the player spawn. Load -> Utility -> Placeholder
  3. Set the checkpoint hotspot checkpoint_id parameter to a value starting at 0 and increasing by 1 for each checkpoint you add
  4. Set the checkpoint hotspot level_hotspot_id parameter to the object id of the overgrowth_level hotspot
  5. Add a goal_<number> parameter to the overgrowth_level hotspot and set the value to reach <number>, with the number from step 3
  6. Add a value to the overgrowth_level hotspot player_spawn parameter, delimited with spaces, with the id of the placeholder object from step 2 (437 243 121). The order matters, and the id for checkpoint 0 should go in the first spot, checkpoint 1 in the second spot, etc. You can see that you've written the correct ID if a transparent character model appears in the placeholder hotspot.

The numbers in checkpoints are tricky to get right. To add an additional checkpoint:

  1. Add another goal param to the overgrowth_level hotspot, and give it a number one higher than the previous goal. So if your previous goal was goal_0, you would add another one with the name goal_1
  2. Set the goal param's value to one higher than the previous goal. So if the previous one was reach 5, this new param's value would be reach 6
  3. Load a checkpoint object, and set its checkpoint_id parameter to a value that matches the reach goal in step #2. So, if the goal is reach 6, then this would just be 6
  4. Set the checkpoint object's level_hotspot_id param
  5. Load a placeholder object for the player to spawn at
  6. Add the id of the placeholder object to the end of the overgrowth_level's player_spawn param. So if it was previously 123 456 then it would now be something like 123 456 784

reach_skippable goal

Do all the same as a "reach" hotspot, but in step 5 set the value to reach_skippable <number> instead of reach <number>

defeat goal

  1. Add an enemy to the level
  2. Add a goal_<number> parameter to the overgrowth_level hotspot and set the value to defeat <number>, with the object id of the enemy from step 1
  3. Add additional enemy ids in the form of defeat <some_enemy_id> <other_enemy_id>, just like in step two (e.g. defeat 4 72 8)

defeat_optional goal

Do all the same as a defeat goal, but in step 2 set the value to defeat_optional <numbers...> instead of defeat <numbers...>

spawn_defeat goal

Do all the same as a defeat goal, but in step 2 set the value to spawn_defeat <numbers...> instead of defeat <numbers...>

Pre/post goal actions

You can trigger an action to happen, either when a goal is set as the "current" goal, or after a goal has been accomplished.

Goal actions can be combined with each other. Just put a space between them (e.g. activate 537 dialogue ShopkeeperBanter). Make sure to put them in the order you want them to happen (if that's important).

Here's a list of actions that can be triggered:

TODO: Add docs for types that haven't be documented below yet (they're all currently listed, just not all documented).

activate make a character with the given id active. This removes the "static" flag from the character. Useful for reducing CPU utilization for characters you haven't reached yet
enable enable a game object with the given id. This can be any object type, not just a character. This will make it appear in game and activate its behavior
disable disable a game object with the given id. This can be any object type, not just a character. This will make it disappear in game and deactivate its behavior
dialogue play a dialogue with the given dialogue name
dialogue_fade same as dialogue 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 same as dialogue_fade action but the dialogue is not triggered at all if you're currently still in combat (TODO: Not sure why this is useful?)
play_success_sting play the success music track, since this was a particularly challenging goal. Usually done on a goal_N_post 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. Set to -1 to let the game select based on the activity level. Set to -2 for silence (TODO: Is this correct for -2?)

activate action

This action is mostly useful for goal_<number>_pre actions, so you can activate static characters right before you come to them and interact with them. It is best used to conserve CPU power when more than 3 or 4 characters are in level.

You can use these both for both enemies and allies, so you don't have to have this character in a defeat goal in order to use it.

You can combine this with other actions.

  1. Add an NPC to the level (friend or enemy)
  2. Set up the NPC with a defeat goal (optional, if this is an enemy you want to have to defeat this goal)
  3. Add a goal_<number>_pre parameter to the overgrowth_level hotspot and set the value to activate <number>, with the object id of the NPC from step 1. The character will be activated just a this goal as set as the active goal.
  4. Repeat 1 and 3 for as many characters as you want, separated with spaces, with a new activate action for each (i.e. goal_3_pre: activate 127 activate 543)

enable action

This action is mostly useful for goal_<number>_pre actions, so you can enable objects (or characters) right before you come to them and interact with them, or right before a particular goal is enabled that involves the object (or character).

(You could use it as a goal_<number>_post action, if it makes sense to, but I'm not sure if that's going to end up being useful quite as frequently)

You can use these for any type of object, so you don't need any particular goal type (e.g. a defeat goal) in order to use this.

You can combine this with other actions.

  1. Spawn an object to the level (any kind)
  2. Set up the goal that you want to this object to be "enabled" by (it appears in level as soon as the goal is set to be active)
  3. Add a goal_<number>_pre parameter to the overgrowth_level hotspot and set the value to enable <number>, with the object id from step 1. The object will be enabled (appear in level) just a this goal as set as the active goal.
  4. Repeat 1 and 3 for as many objects as you want, separated with spaces, with a new enable action for each (i.e. goal_3_pre: enable 127 enable 543)

disable action

This action is useful for both goal_<number>_post and goal_<number>_pre actions, so you can disable objects (or characters) right after you come to them and interact with them, or right before a particular goal is enabled that shouldn't have those objects (or characters) present (e.g. after an defeat_optional goal.

You can use these for any type of object, so you don't need any particular goal type (e.g. a defeat goal) in order to use this.

You can combine this with other actions.

  1. Spawn an object to the level (any kind)
  2. Set up the goal that you want to this object to be "disabled" by (it appears in level as soon as the goal is set to be active)
  3. Add a goal_<number>_pre (or goal_<number>_post) parameter to the overgrowth_level hotspot and set the value to disable <number>, with the object id from step 1. The object will be disabled (disappear from level) just a this goal as set as the active goal (or just as the goal is completed, if it is a _post goal).
  4. Repeat 1 and 3 for as many objects as you want, separated with spaces, with a new disable action for each (i.e. goal_3_pre: disable 127 disable 543)

dialogue action

This action is useful for both goal_<number>_pre and goal_<number>_post 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 goal_<goalnumber>_pre 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.

You can combine this with other actions.

Instructions:

  1. 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
  2. Set up the goal that you want this dialogue to be triggered by
  3. Add a goal_<goalnumber>_pre (or goal_<number>_post) parameter to the overgrowth_level hotspot and set the value to dialogue <dialoguename>.
    The dialoguename parameter should be set to dialogue name from step 1. The goalnumber parameter is goal from step 2 that you want the dialogue to be triggered before (or after).

To trigger a dialogue just after achieving a checkpoint goal (whether a "reach" or "defeat" checkpoint):

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

Troubleshooting

General

Make sure you don't use a start_dialogue hotspot on top of the player's spawn. Doing this will likely break the checkpoint system.

If you need to start a dialogue at the beginning of the level, use a goal_0_pre instead, with a value of dialogue "dialogue name here". Make sure you're setting the dialogue's name in the dialogue editor, and not in the script params or "Selected" window.

overgrowth_level_checkpoint

Open up all of your overgrowth_level_checkpoint instances, and look at the script parameters for them.

  • Make sure that checkpoint_id starts at zero, and increases by 1 (and only by 1) for each subsequent checkpoint. This will be true even if the first reach goal isn't goal_0!
  • Make sure that reach N values match the values for checkpoint_id.
Example of matching up "reach" and "hotspot_id" values

overgrowth_level

Open up the script parameters for the overgrowth_level instance, and look at the script parameters.

  • The goals should start at goal_0, not at goal_1.
  • Look at the player_spawn property. Count up the number of Ids in there (separated with spaces), and count up the number of reach goals you have. Those should be the same count.
  • Make sure that each player_spawn id corresponds to a placeholder object in the world, and that you see a turner in a T-Pose inside each of them (which means that you typed them correctly in the player_spawn field).
Example of matching up player_spawn and placeholder object id values
Personal tools