Return to base directive
- This article requires proofreading by native speakers of English
A Return to base directive (RTB directive for short) is a jargon expression the FreeSpace community uses to refer to a directive that tells the player when he is allowed to return to base. All non-red-alert missions that have debriefing must have one RTB directive. Missions that are chained using red-alert typically do not have an RTB directive, because the mission ends automatically as soon as certain mission objectives are met.
Creating an RTB directive
The FREDder will need at least two events for a properly working RTB directive. (More than two are needed if the RTB is at the end of a chain of events.) The first directive collects all the necessary conditions that should be met to trigger the RTB directive. The second is the "Return to base" directive itself. It must be chained to the first event, otherwise the "Return to base" directive will pop up immediately. Typically, the RTB directive consists of a has-departed-delay SEXP that checks if the player has jumped out.
Chaining one event to another is possible by ticking the "Chained" feature. A chained event is connected to the event that precedes it only. So, in simpler terms, the RTB directive's event must be directly below the "collect all outcomes" one. Add the "Return to base" Directive Text to your event.
In this example mission, the player's wing is ordered to destroy an Aeolus cruiser that jumps out after 45 seconds. Two possibilities should be accounted for by the RTB directive:
- The cruiser gets destroyed
- The cruiser escapes
Either will trigger the RTB directive. Logically, the two cannot happen at the same time, so the FREDder is restricted to using the or SEXP instead of and. The RTB chain should look like this:
Ignore the "Gorre directive." It is unrelated to the RTB chain.
The "Conditions to depart" event collects all the necessary conditions that trigger the "Return to base" directive. The sample mission could have used the much more straightforward destroyed-or-departed-delay, but the way it is done here is more demonstrative, because of the or conditional. If the Gorre (the Aeolus) is destroyed or escapes, the event will turn true and trigger the RTB directive. For an RTB directive, it makes no difference if the mission's outcome is favorable or unfavorable to the player. (This event can also be used for making AWOL debriefing stages. The send-message SEXP will send a message that tells the player that he is allowed to jump out (optional).
The "RTB directive" event will give the "Return to base" directive. Apparently, it is chained to the "Conditions to depart" event. FreeSpace ignores a chained event until the event that it is chained to becomes true. If the "Conditions to depart" event is true, the "RTB directive" event will be triggered. Once triggered, it will work like any other events, so its "Return to base" directive will be displayed on the HUD.
- You can name the events however you prefer. The point is that you should be able to recognize the events based on their names. If you're working with dozens of ambiguously named events, you will not be able to tell which one does what without opening the tree.
- The "Chained" option should never be ticked for the first event of a given chain. Otherwise, FreeSpace will assume that the event that is above it is the first element of the chain.
Sample mission (Tested in FreeSpace Open 3.6.9., optimized for Easy, could be used to learn about AWOL debriefing stages.)