Structs - Revision history

Wormbo: /* Accessing structs in arrays */ fixed the new example code

2011-08-17T13:50:28Z

‎Accessing structs in arrays: fixed the new example code

Crusha: Beware of the fact that iterators will make a copy of the struct instead of a reference.

2011-08-17T12:02:00Z

Beware of the fact that iterators will make a copy of the struct instead of a reference.

Crusha: Added description for modifiers "Atomic" and "AtomicWhenCooked".

2011-05-20T21:04:37Z

Added description for modifiers "Atomic" and "AtomicWhenCooked".

WGH: /* Member declarations */

2011-02-05T15:27:10Z

‎Member declarations

Eliot: /* Native struct code */

2010-07-10T02:49:15Z

‎Native struct code

Eliot: /* Modifiers */ Sorted modifiers

2010-06-10T01:30:43Z

‎Modifiers: Sorted modifiers

Eliot at 21:50, 20 May 2010

2010-05-20T21:50:27Z

Eliot: /* Default member values */

2010-05-19T22:33:48Z

‎Default member values

Eliot: /* Other modifiers */

2010-05-19T22:28:48Z

‎Other modifiers

Eliot at 22:14, 19 May 2010

2010-05-19T22:14:00Z

@@ Line 89: / Line 89: @@
      for (i = 0; i < Colors.Length; i++)
+     {
-         if (Iterator.G == 0.0 && Iterator.B == 0.0)
+         if (Colors[i].G == 0.0 && Colors[i].B == 0.0)
-             Iterator.R = 1.0; // This effects the real struct values in the array.
+             Colors[i].R = 1.0; // This effects the real struct values in the array.
+     }
+}

@@ Line 61: / Line 61: @@
      super.PreBeginPlay();  // Call the parent(i.e. Actor) PreBeginPlay() event
      RedColor.R = 1.0; // Make RedColor really red, assuming A is 1.0 and G and B are 0.0.
+}
 </uscript>
 {{navbox unrealscript}}

@@ Line 23: / Line 23: @@
 ===Modifiers affecting values===
 ; Immutable<sup>3</sup>, ImmutableWhenCooked<sup>3</sup> : The struct uses [[wp:Serialization|binary serialization]](in previous engine versions some structs used hardcoded binary serialization in c++ e.g. [[Vector]], [[Rotator]] and [[Color]] etc). Without this flag, each struct member will be saved with a ''nameindex'' followed by a ''packedbyte'', ''size'' and ''arrayindex'', then the value of the specific member, thus increases file size and slows down the serialization process.
 ; StrictConfig<sup>3</sup> : When the struct variable is flagged with ''[[config]]/[[GlobalConfig|globalconfig]]'' then only members with the flag ''config/globalconfig'' will be readable from the .ini, instead of all members.
 ; Transient<sup>2,3</sup> : See [[Variables#Modifiers_affecting_values|Transient]] but instead it applies to all the members of the struct.
 ===Other modifiers===
 ; Export<sup>2,3</sup> : The struct is supposed to be exported to native headers.
 ; Init<sup>2,3</sup> : '''???'''

@@ Line 35: / Line 35: @@
 ==Member declarations==
 Struct members are declared like class [[variables]]. A variable group name or certain [[Variables#Modifiers|variable modifiers]] don't make sense for struct members, though.
 ===Default member values===

@@ Line 42: / Line 42: @@
 ==Native struct code==
-Like native classes, some structs in [[Unreal Engine 2]] and 3 games may contain native code snippets in UnrealScript. These declarations do not affect UnrealScript directly, but they are exported when auto-generating native headers while compiling UnrealScript classes. In [[Unreal Tournament 2004|UT2004]] there are only two struct like this, [[UE2:GUI (UT2004)#GUITreeNode|GUI.GUITreeNode]] and [[UE2:GUIMultiColumnList (UT2004)#MultiColumnSortData|GUIMultiColumnList.MultiColumnSortData]]. In Unreal Engine 3 games this is a much more common sight, especially in UI-related classes.
+Like native [[class#Native class code|class]]es, some structs in [[Unreal Engine 2]] and 3 games may contain native code snippets([[cpptext]]) in UnrealScript. These declarations do not affect UnrealScript directly, but they are exported when auto-generating native headers while compiling UnrealScript classes. In [[Unreal Tournament 2004|UT2004]] there are only two struct like this, [[UE2:GUI (UT2004)#GUITreeNode|GUI.GUITreeNode]] and [[UE2:GUIMultiColumnList (UT2004)#MultiColumnSortData|GUIMultiColumnList.MultiColumnSortData]]. In Unreal Engine 3 games this is a much more common sight, especially in UI-related classes.
 In Unreal Engine 2 native struct code is enclosed in a '''cppstruct''' block. Unreal Engine 3 uses a '''structcpptext''' block instead.

@@ Line 19: / Line 19: @@
 ===Modifiers affecting UnrealEd===
-; long<sup>2</sup>{{confirm}}: Specifies that the struct contains many members and should not be examined when generating a value string for struct variables in [[UnrealEd]]'s [[Actor properties window]]. Usually structs like [[Vector]] are displayed as "(X=1.2,Y=3.4,Z=5.6)", but with the '''long''' modifier only "(...)" is displayed.
+; Long<sup>2</sup>{{confirm}}: Specifies that the struct contains many members and should not be examined when generating a value string for struct variables in [[UnrealEd]]'s [[Actor properties window]]. Usually structs like [[Vector]] are displayed as "(X=1.2,Y=3.4,Z=5.6)", but with the ''long'' modifier only "(...)" is displayed.
 ===Modifiers affecting values===
-; strictconfig<sup>3</sup>: ''?''
+; StrictConfig<sup>3</sup> : When the struct variable is flagged with ''config/globalconfig'' then only members with the flag ''config/globalconfig'' will be readable from the .ini, instead of all members.
 ===Other modifiers===
-; atomic<sup>3</sup>: {{Expand}}
+; Atomic<sup>3</sup>, AtomicWhenCooked<sup>3</sup> : '''???'''
-; atomicwhencooked<sup>3</sup>: {{Expand}}
+; Export<sup>2,3</sup> : The struct is supposed to be exported to native headers.
-; export<sup>2,3</sup> : The struct is supposed to be exported to native headers.
+; Immutable<sup>3</sup>, ImmutableWhenCooked<sup>3</sup> : The struct uses [[wp:Serialization|binary serialization]](in previous engine versions some structs used hardcoded binary serialization in c++ e.g. [[Vector]], [[Rotator]] and [[Color]] etc). Without this flag, each struct member will be saved with a ''nameindex'' followed by a ''packedbyte'', ''size'' and ''arrayindex'', then the value of the specific member, thus increases file size and slows down the serialization process.
-; immutable<sup>3</sup>: {{Expand}}
+; Init<sup>2,3</sup> : '''???'''
-; immutablewhencooked<sup>3</sup>: {{Expand}}
+; Native<sup>2,3</sup> : The struct includes native logic.
-; init<sup>2,3</sup> : {{Expand}}
+; Transient<sup>2,3</sup> : See [[Variables#Modifiers_affecting_values|Transient]] but instead it applies to all the members of the struct.
-; native<sup>2,3</sup> : The struct includes native logic.
-; transient<sup>2,3</sup> : See [[Variables#Modifiers_affecting_values|Transient]] but instead it applies to all the members of the struct.
 ; {''native type name''}<sup>3</sup> : The type to use in [[native]] code instead of this struct type. This is mainly a hack in Unreal Engine 3 to declare variables in UnrealScript with types the UnrealScript language does not provide. There are only three instances of this syntax in [[UT3]]. The structs [[UE3:Object (UT3)#qword|Object.qword]] and [[UE3:Object (UT3)#double|Object.double]] represent the native types [[wp:Qword#Dword_and_Qword|QWORD]] and [[wp:Double_precision_floating-point_format|DOUBLE]] respectively, and the struct [[UE3:UIEditorOptions (UT3)#ViewportDimension|UIEditorOptions.ViewportDimension]] represents the native type [http://docs.wxwidgets.org/trunk/classwx_rect.html WxRect].

@@ Line 41: / Line 41: @@
 By default all struct member variables are initialized with the [[null value]] of the corresponding type.
-Starting with [[Unreal Engine 3]], struct members can also have a default value other than the corresponding null value. This can be defined in a [[structdefaultproperties]] block inside the struct declaration. A good example is the [[UE3:Object (UT3)#LinearColor|LinearColor]] struct from [[UT3]]:
+Starting with [[Unreal Engine 3]], struct members can also have a default value other than the corresponding null value. This can be defined in a [[structdefaultproperties]] block inside the struct declaration. See [[Defaultproperties#Default_struct_properties|structdefaultproperties]] for more details.
-<uscript>
-// A linear color.
-struct immutable LinearColor
-−
-	var() float R, G, B, A;
-−
-	structdefaultproperties
-−
-		A=1.f
-−
-};
-</uscript>
-LinearColor declared four members of type [[float]]. The default value of member '''A''' is defined to be <code>1.0</code>, while all other members keep <code>0.0</code> as their default value. This means, whenever a variable of type LinearColor is declared, its '''A''' component already contains the value <code>1.0</code>, while the '''R''', '''G''', and '''B''' components have the value <code>0.0</code>.
 ==Native struct code==

← Older revision		Revision as of 22:14, 19 May 2010
Line 60:		Line 60:

	In Unreal Engine 2 native struct code is enclosed in a '''cppstruct''' block. Unreal Engine 3 uses a '''structcpptext''' block instead.		In Unreal Engine 2 native struct code is enclosed in a '''cppstruct''' block. Unreal Engine 3 uses a '''structcpptext''' block instead.
		+
		+	==Accessing structs==
		+	Accessing a struct is as easily as accessing a [[class]], here's an example.
		+	<uscript>
		+	class A extends Actor;
		+
		+	var() LinearColor RedColor;
		+
		+	// Modify RedColor at Runtime rather than on defaultproperties.
		+	event PreBeginPlay()
		+	{
		+	super.PreBeginPlay(); // Call the parent(i.e. Actor) PreBeginPlay() event
		+	RedColor.R = 1.0; // Make RedColor really red, assuming A is 1.0 and G and B are 0.0.
		+	}
		+	</uscript>

	{{navbox unrealscript}}		{{navbox unrealscript}}