Variables - Revision history

Wormbo: /* Modifiers */ somehow the struct member tag got lost when moving modifier info to a template

2015-09-16T16:51:18Z

‎Modifiers: somehow the struct member tag got lost when moving modifier info to a template

WGH: /* Access modifiers */

2014-02-22T17:10:22Z

‎Access modifiers

Eliot: /* Local variables */

2013-05-16T08:48:14Z

‎Local variables

Eliot: Local variables also work in States since UDK 2011.

2013-05-14T23:03:52Z

Local variables also work in States since UDK 2011.

Eliot: /* Modifiers affecting UnrealEd */ Moved SerializeText.

2012-12-17T21:23:36Z

‎Modifiers affecting UnrealEd: Moved SerializeText.

Eliot: /* Modifiers with unknown effect */ Add CrossLevelActive, remove SerializeText

2012-12-17T21:12:43Z

‎Modifiers with unknown effect: Add CrossLevelActive, remove SerializeText

66.46.205.188 at 13:22, 3 October 2012

2012-10-03T13:22:05Z

Krylose: Added link to the Legacy:INI File page

2012-04-19T15:49:04Z

Added link to the Legacy:INI File page

Eliot: /* Editable variables */ Added optionl subgroup

2011-11-23T21:06:55Z

‎Editable variables: Added optionl subgroup

Eliot: /* Modifiers with unknown effect */

2011-05-05T17:31:02Z

‎Modifiers with unknown effect

@@ Line 40: / Line 40: @@
 For class and struct variables you are allowed to specify one or more variable modifiers. These change the way the variable works in certain situations.
 {{Infobox EngineVersion|modifier}}
 ===Inner type modifiers===

@@ Line 46: / Line 46: @@
 ===Access modifiers===
 The following modifiers only apply to class variables and specify, which other classes are allowed to access the variable. The access rules are enforced by the compiler.
-; Const<sup>S</sup>: Prevents any changes to this variable from within UnrealScript. You are still allowed to specify a value in the [[defaultproperties]] block and access the variable's value in your code. This property is mostly used to protect variables with a special meaning to native code. Classes with '''const''' variables usually have a corresponding setter function for each variable.
+; Const<sup>S</sup>: Prevents any changes to this variable from within UnrealScript. You are still allowed to specify a value in the [[defaultproperties]] block and access the variable's value in your code. This property is mostly used to protect variables with a special meaning to native code. Classes with '''const''' variables usually have a corresponding setter function for each variable. With bytecode level hacking, it's possible to assign a value to a const variable, but in general, the effect is undefined (ranging from giving the result you want to crashing the game).
 ; Deprecated<sup>2,3</sup>: Signals that this variable should no longer be used. Accessing deprecated variables will throw a compiler warning. [[Unreal Engine 3]] will load the value of a '''deprecated''' variable, but ignore it during save.
 ; Private<sup>S,2,3</sup>: Private variables can only be accessed from within the class they were declared in. Other classes, even subclasses, can't access them.

← Older revision		Revision as of 08:48, 16 May 2013
Line 35:		Line 35:


−	'''Note''': As of UDK 2011-??{{confirm}} it is also possible to declare local variables in [[state]]s. Local variables must be declared before [[ignores]].	+	'''Note''': As of UDK 2011-06+?{{confirm}} it is also possible to declare local variables in [[state]]s. Local variables must be declared before [[ignores]].

	==Modifiers==		==Modifiers==

@@ Line 4: / Line 4: @@
 * Class variables, which can only be declared at the [[class]] [[wp:Scope (programming)|scope]], before any function, operator, delegate or [[state]] declaration.
 * Struct members, which are declared inside their [[struct]]'s declaration block.
-* Local variables, which can be declared at the start of [[function]], [[operator]] and [[delegate]] bodies before any code statements. (For readability's sake, this article will imply operators and delegates when it mentions functions, unless otherwise noted.)
+* Local variables, which can be declared at the start of [[function]], [[state]], [[operator]] and [[delegate]] bodies before any code statements. (For readability's sake, this article will imply operators and delegates when it mentions functions, unless otherwise noted.)
 ==Declaration==
@@ Line 33: / Line 33: @@
 After declaration, a local variable is initially null, which can mean different things, depending on the variable type. (Zero for numeric types, False, empty string or array, None, etc.)
 ==Modifiers==

@@ Line 72: / Line 72: @@
 These modifiers have some kind of effect in [[UnrealEd]], usually in the actor properties window.
-; edfindable<sup>S,2</sup>: Adds a 'Find' button to the variable in the property window, which can be used to select an actor from the UnrealEd viewports. For obvious reasons this only makes sense for variables of type Actor or any of its subclasses.
+; EdFindable<sup>S,2</sup>: Adds a 'Find' button to the variable in the property window, which can be used to select an actor from the UnrealEd viewports. For obvious reasons this only makes sense for variables of type Actor or any of its subclasses.
-; editconst<sup>S</sup>: The variable is read-only in the property window.
+; EditConst<sup>S</sup>: The variable is read-only in the property window.
-; editconstarray<sup>S,2</sup>, editfixedsize<sup>S,3</sup>: For dynamic arrays, removes the buttons from the properties window that would change the array length.
+; EditConstArray<sup>S,2</sup>, editfixedsize<sup>S,3</sup>: For dynamic arrays, removes the buttons from the properties window that would change the array length.
-; edithide<sup>S,3+</sup>: Hide in [[UnrealEd]] property lists.{{confirm}}
+; EditHIde<sup>S,3+</sup>: Hide in [[UnrealEd]] property lists.{{confirm}}
-; editinline<sup>S,2,3</sup>: Only meaningful for object variables. Displays the referenced object's properties as a subgroup below the variable in the property window. If the variable has the value None, a drop-down list of allowed ([[editinlinenew]], non-[[abstract]]) classes can be used to create a new object which is assigned to this variable.
+; EditInline<sup>S,2,3</sup>: Only meaningful for object variables. Displays the referenced object's properties as a subgroup below the variable in the property window. If the variable has the value None, a drop-down list of allowed ([[editinlinenew]], non-[[abstract]]) classes can be used to create a new object which is assigned to this variable.
-; editinlineuse<sup>S,2,3</sup>: Same as '''editinline''', but also adds a 'Use' button to the variable to apply the object selected in the relevant browser for this type of object. Note that the 'Use' button is always available in [[Unreal Engine 3]].
+; EditInlineUse<sup>S,2,3</sup>: Same as '''editinline''', but also adds a 'Use' button to the variable to apply the object selected in the relevant browser for this type of object. Note that the 'Use' button is always available in [[Unreal Engine 3]].
-; editoronly<sup>3+</sup>: The variable value is only loaded for [[UnrealEd]].
+; EditorOnly<sup>3+</sup>: The variable value is only loaded for [[UnrealEd]].
-; edittextbox<sup>S?,3+</sup>: Replaces the usual input box with a button for opening a separate dialog with a multi-line text box for entering. Probably only useful for [[string]] variables.
+; EditorTextBox<sup>S?,3+</sup>: Replaces the usual input box with a button for opening a separate dialog with a multi-line text box for entering. Probably only useful for [[string]] variables.
-; interp<sup>3</sup>: The variable can be manipulated by [[Unreal Engine 3]]'s [[Matinee]] system. Only really meaningful for float and vector variables.
+; Interp<sup>3</sup>: The variable can be manipulated by [[Unreal Engine 3]]'s [[Matinee]] system. Only really meaningful for float and vector variables.
-; noclear<sup>S,3</sup>: Instructs the editor to prevent the user from setting this variable to None. Only really meaningful for object variables.
+; NoClear<sup>S,3</sup>: Instructs the editor to prevent the user from setting this variable to None. Only really meaningful for object variables.
-; noimport<sup>S,3</sup>: The variable's value will not be imported from text representation, i.e. when importing from a [[T3D file]] or pasting from clipboard.
+; NoImport<sup>S,3</sup>: The variable's value will not be imported from text representation, i.e. when importing from a [[T3D file]] or pasting from clipboard.
-; nontransactional<sup>S,3</sup>: The variable is not affected by UnrealEd's undo/redo features.
+; NonTransactional<sup>S,3</sup>: The variable is not affected by UnrealEd's undo/redo features.
 ===Other modifiers===

@@ Line 100: / Line 100: @@
 The effects of these modifiers are not known yet.
 ; Archetype<sup>3</sup>: Effect unknown. Used only for the [[UE3:UIPrefabInstance (UT3)#SourcePrefab|UIPrefabInstance.SourcePrefab]] variable in UT3.
 ; CrossLevelPassive<sup>3+</sup>: Probably related to level streaming or multiple levels loaded at the same time.
 ==Initial values==

@@ Line 101: / Line 101: @@
 ; Archetype<sup>3</sup>: Effect unknown. Used only for the [[UE3:UIPrefabInstance (UT3)#SourcePrefab|UIPrefabInstance.SourcePrefab]] variable in UT3.
 ; CrossLevelPassive<sup>3+</sup>: Probably related to level streaming or multiple levels loaded at the same time.
-; SerializeText<sup>3+</sup>: Effect unknown. Used only for the [[UE3:StaticMeshComponent (UDK)#LODData|StaticMeshComponent.LODData]] variable in the UDK.
+; SerializeText<sup>3+</sup>: Variable will not be saved, but will be transfered during copy-paste operations (which are done through text). Works only on native variables. Used only for the [[UE3:StaticMeshComponent (UDK)#LODData|StaticMeshComponent.LODData]] variable in the UDK.
 ::''Requirements'': '''Native'''

@@ Line 56: / Line 56: @@
 ; Automated<sup>UT2004</sup>: Only meaningful for object variables in [[UE2:GUIMultiComponent (UT2004)|GUIMultiComponent]] classes. Indicates that any [[UE2:GUIComponent (UT2004)|GUIComponent]] object(s) referenced by this variable should automatically be added to the [[UE2:GUIMultiComponent_(UT2004)#Controls|Controls]] array. Also works for [[static array|static]] and [[dynamic arrays]]. Objects that aren't GUIComponents are ignored.
 ::''Implies'': '''noexport''', '''editinline''', '''editinlineuse''' and '''editinlinenotify''', and FYI: any object variable(even parameters and locals) referencing GUIComponents implies '''export''' and '''editinline'''.
-; Config<sup>S</sup>: Makes the variable configurable. The default variable value is read from an [[INI file]] when the class is loaded. Each subclass has its own version of the variable value in its INI file section. If the class is declared with the [[PerObjectConfig]] modifier, the initial instance value of the variable is read from a separate INI section for that object instance.
+; Config<sup>S</sup>: Makes the variable configurable. The default variable value is read from an [[Legacy:INI_File|INI file]] when the class is loaded. Each subclass has its own version of the variable value in its INI file section. If the class is declared with the [[PerObjectConfig]] modifier, the initial instance value of the variable is read from a separate INI section for that object instance.
 ; DataBinding<sup>3</sup>: The variable can be manipulated by [[Unreal Engine 3]]'s data store system.
 ; DuplicateTransient<sup>3</sup>: Similar to '''transient''' (see below) but applies to object duplication.

@@ Line 22: / Line 22: @@
 ===Editable variables===
 To make the variable accessible from within [[UnrealEd]]'s property windows, use the following syntax:
-  '''var('''''[groupname]''''')''' ''[[#Modifiers|[modifiers]]]'' [[type]] variablename''';'''
+  '''var('''''[groupname[,subgroup<sup>3</sup>]]''''')''' ''[[#Modifiers|[modifiers]]]'' [[type]] variablename''';'''
 The ''groupname'' must be an identifier if specified. If omitted, the class name is used as group name. For struct members, the group name has no effect.