Flag Reference

From Creation Kit
Jump to: navigation, search

Flags are words that can be applied to a script itself, properties, variables, or functions. The flags may change how something compiles and provide additional information to the game or Creation Kit.

Script Flags

  • Conditional: Flags this script as viewable by the condition system. The Creation Kit will not let you attach more then one conditional script to the same object.
  • Const: Flags this script as const. Const scripts may not contain non-const variables, non-const auto properties, or states. Const scripts cannot be stored in script variables.
  • DebugOnly: Flags this script as debug-only. All functions in this script will be compiled out in release builds when used in other scripts.
  • BetaOnly: Flags this script as beta-only. All functions in this script will be compiled out in final builds when used in other scripts.
  • Hidden: Hides this script from the normal list of scripts in the Creation Kit that shows when someone wants to attach a script to an object. This is usually used for things that aren't intended to be attached to anything by the user (like fragments), or by base scripts that don't do anything on their own except to be extended by a non-hidden script.
  • Native: Flags this script as native. Native scripts may not contain data or states. Non-native scripts may not define new events or native functions.
  • Default: Flags this script as a "default" script. Has no effect other then to be classified as such in the Creation Kit's add script window for ease of finding it.

Property Flags

  • Conditional: (Auto properties only) Flags the hidden variable of an auto property to be visible to the condition system. The script must also have the conditional flag.
  • Const: (Auto properties only) Flags this property's value as const. The property's value can only be changed in the editor and will not be loaded from save games (so the editor-given value will always be used, even if saved with a different one)
  • Hidden: Hides this property from the property window. Usually used for values you don't want the Creation Kit to change, but which you want other scripts to view.
  • Mandatory: Causes the editor to issue a warning if this property isn't filled. Will also show unfilled mandatory properties as red in the property window, and warn the user if they attempt to close the property window without filling said properties.

Variable Flags

  • Conditional: Flags the variable to be visible to the condition system. The script must also have the conditional flag.
  • Const (non-struct members only): Flags this variable's value as const. The variable's value must be set on the same line it is defined in the script and will not be loaded from save games (so the script-given initial value will always be used, even if saved with a different one)
  • Hidden (struct members only): Hides this variable from the property window. Usually used for values you don't want the Creation Kit to change, but which you want other scripts to view.

Group Flags

  • CollapsedOnRef: The group will appear collapsed by default when the properties window is viewed on a reference.
  • CollapsedOnBase: The group will appear collapsed by default when the properties window is viewed on a base object.
  • Collapsed: The group will always appear collapsed by default

Function Flags

  • DebugOnly: Flags this function as debug-only. This function will be compiled out in release builds when called.
  • BetaOnly: Flags this function as beta-only. This function will be compiled out in final builds when called.