Difference between revisions of "Red-alert"

From FreeSpace Wiki
Jump to: navigation, search
(added link to variables)
(Added section on usage)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
red-alert
 
 
     red-alert
 
     red-alert
 
     Causes Red Alert status in a mission. This function ends the current mission, and moves to the next mission
 
     Causes Red Alert status in a mission. This function ends the current mission, and moves to the next mission
Line 10: Line 9:
  
 
Regardless, red-alert missions often cause errors in retail and SCP FreeSpace, so avoid them if it all possible. This can be done using campaign-persistent [[variables]] to "remember" the status of various craft just before the player departs.
 
Regardless, red-alert missions often cause errors in retail and SCP FreeSpace, so avoid them if it all possible. This can be done using campaign-persistent [[variables]] to "remember" the status of various craft just before the player departs.
 +
While most of the bugs that caused these errors have been fixed in FSO version 3.6.10, there is still no absolute guarantee that this sexp will work each time, every time.
  
If you want to make a red-alert occur as the player jumps out, create an event that waits for the player to hit ALT+J. Chain to it an event that causes the red-alert to occur 3-4 seconds after the keypress and when the ship has reached jumpout velocity (40 m/s).
+
==Usage==
 +
If you want to make a red-alert occur as the player jumps out, create an event that waits for the player to hit ALT+J. Chain to it an event that causes the red-alert to occur once the ship has reached jumpout velocity (40 m/s) to give the red-alert a few seconds to go into effect.
 +
 
 +
*Ships that have the "red-alert-carry" flag will have their hull HP, shield HP, subsystems HP, and weapon ammo counts saved to an internal buffer which is then used to init the red-alert mission.
 +
*The carried ships '''''MUST''''' have the same name and the "red-alert-carry" flag set in '''''BOTH''''' the source mission and the red-alert mission in order for a successful red-alert mission to start.
 +
**The ships do not have to be the same type, but it is highly recommended that they are if the ships are not a player craft nor in one of the player's wings.
 +
** Trivia: Older versions of FSO (and FS2) only required the "red-alert-carry" flag be defined in the red-alert mission. Somewhere along the line, this code was refactored to require the flag be present in both the source mission and the red-alert mission.
 +
[[Category:Retail SEXPs]]

Latest revision as of 07:51, 21 January 2017

   red-alert
   Causes Red Alert status in a mission. This function ends the current mission, and moves to the next mission
   in the campaign under red alert status. There should only be one branch from a mission that uses this expression.
   Takes no arguments.

Comments

Despite what the SEXP description says, red-alert has been tested with a simple branching campaign and it appears that you can branch off of a red-alert mission.

Regardless, red-alert missions often cause errors in retail and SCP FreeSpace, so avoid them if it all possible. This can be done using campaign-persistent variables to "remember" the status of various craft just before the player departs. While most of the bugs that caused these errors have been fixed in FSO version 3.6.10, there is still no absolute guarantee that this sexp will work each time, every time.

Usage

If you want to make a red-alert occur as the player jumps out, create an event that waits for the player to hit ALT+J. Chain to it an event that causes the red-alert to occur once the ship has reached jumpout velocity (40 m/s) to give the red-alert a few seconds to go into effect.

  • Ships that have the "red-alert-carry" flag will have their hull HP, shield HP, subsystems HP, and weapon ammo counts saved to an internal buffer which is then used to init the red-alert mission.
  • The carried ships MUST have the same name and the "red-alert-carry" flag set in BOTH the source mission and the red-alert mission in order for a successful red-alert mission to start.
    • The ships do not have to be the same type, but it is highly recommended that they are if the ships are not a player craft nor in one of the player's wings.
    • Trivia: Older versions of FSO (and FS2) only required the "red-alert-carry" flag be defined in the red-alert mission. Somewhere along the line, this code was refactored to require the flag be present in both the source mission and the red-alert mission.