Subobjects - Revision history

Eliot: Fixed UC File link

2010-04-22T04:35:54Z

Fixed UC File link

Wormbo at 09:39, 15 December 2008

2008-12-15T09:39:12Z

Wormbo: /* Subobjects in exported source code */ note about illegal syntax elements in exported UT3 subobjects

2008-05-10T21:13:05Z

‎Subobjects in exported source code: note about illegal syntax elements in exported UT3 subobjects

Wormbo: Subobject moved to Subobjects over redirect: makes more sense

2008-05-10T21:04:49Z

Subobject moved to Subobjects over redirect: makes more sense

Wormbo: New page: The term '''subobject''' refers to a special kind of object and its textual definition in a defaultproperties block of a class in. Depending on the context, a subobject can either be a...

2008-05-10T21:00:17Z

New page: The term '''subobject''' refers to a special kind of object and its textual definition in a defaultproperties block of a class in. Depending on the context, a subobject can either be a...

New page

The term '''subobject''' refers to a special kind of object and its textual definition in a [[defaultproperties]] block of a class in. Depending on the context, a subobject can either be a template or an actual object. In [[Unreal Engine 3]] they are generally templates (actually [[archetypes]]), while in [[Unreal Engine 2]] subobjects are generally actual objects unless their class is declared with the [[Class#Modifiers|class modifier]] "instanced", which applies to all [[UE2:GUI (UT2004)|GUI]] subclasses in [[UT2003]] and [[UT2004]]. There is no support for subobjects in [[Unreal Engine 1]].

Subobjects that are only templates are "instanced" (i.e. created) when an object of the class containing the subobject definition is created. Generally, the property '''Outer''' of an instanced subobject points to the containing object, while the '''Outer''' property of "actual object" subobjects points to the class defining the subobject. An example for the latter case is the UT200x class [[UE2:Shark (UT2004)|xEffects.Shark]], which creates a [[UE2:FinalBlend (UT2004)|FinalBlend]] as a subobject and uses it as Skin.

==Syntax==
To define a subobject, add the following to the defaultproperties block of your class:
'''Begin Object Name='''''objectname'' '''Class='''''classname''
''subobject properties''
'''End Object'''
For the subobject properties the same syntax and rules apply as for the defaultproperties block itself.

The Class=… part is optional in [[Unreal Engine 3]]. Omitting it means that you want to duplicate a subobject with the same name defined in a parent class.

==Subobjects in exported source code==
It is generally a good idea to be suspicious of any [[defaultproperties]] section in a [[UC file]] created by exporting scripts from a compiled package. This goes especially for subobjects!

Subobject definitions may not get exported at all in early [[Unreal Engine 2]] implementations. In newer versions subobjects will only be exported if they are either assigned to at least one property declared with the [[Variables#Modifiers|modifier]] '''export''' or if a property they are assigned to is of a type that is declared as '''instanced'''. For example a tooltip object assigned to the [[UE2:GUIComponent properties (UT2004)#ToolTip|GUIComponent.ToolTip]] property would get exported because the property's type is [[UE2:GUIToolTip (UT2004)|GUIToolTip]], a subclass of [[UE2:GUI (UT2004)|GUI]], which is declared with the '''instanced''' class modifier. Any karma parameter subobject assigned to the [[UE2:Actor properties (UT2004)#KParams|Actor.KParams]] property would be exported because that property is declared with the '''export''' variable modifier.

Subobjects in [[Unreal Engine 3]] are only exported if the subobject's class is a subclass of [[UE3:Component (UT3)|Component]]. A prominent example of this behavior is the [[UE3:UIObject (UT3)|UIObject]] class. Its subobject WidgetInitializedEvent is not exported because it's a [[UE3:UIEvent_Initialized (UT3)|UIEvent_Initialized]], which is not a Component subclass, while its other subobject [[UE3:UIObject (UT3)#WidgetEventComponent|WidgetEventComponent]] (class [[UE3:UIComp_Event (UT3)|UIComp_Event]]) is exported.

As you can see, it's always a good idea to have a look at the original (downloaded, not exported) sources if you want to find out about subobject usage.

{{navbox unrealscript}}

← Older revision		Revision as of 09:39, 15 December 2008
Line 1:		Line 1:
−	The term '''subobject''' refers to a special kind of object and its textual definition in a [[defaultproperties]] block of a class in. Depending on the context, a subobject can either be a template or an actual object. In [[Unreal Engine 3]] they are generally templates (actually [[archetypes]]), while in [[Unreal Engine 2]] subobjects are generally actual objects unless their class is declared with the [[Class#Modifiers\|class modifier]] "instanced", which applies to all [[UE2:GUI (UT2004)\|GUI]] subclasses in [[UT2003]] and [[UT2004]]. There is no support for subobjects in [[Unreal Engine 1]].	+	The term '''subobject''' refers to a special kind of object and its textual definition in a [[defaultproperties]] block of a class. Depending on the context, a subobject can either be a template or an actual object. In [[Unreal Engine 3]] they are generally templates (actually [[archetypes]]), while in [[Unreal Engine 2]] subobjects are generally actual objects unless their class is declared with the [[Class#Modifiers\|class modifier]] "instanced", which applies to all [[UE2:GUI (UT2004)\|GUI]] subclasses in [[UT2003]] and [[UT2004]]. There is no support for subobjects in [[Unreal Engine 1]].

	Subobjects that are only templates are "instanced" (i.e. created) when an object of the class containing the subobject definition is created. Generally, the property '''Outer''' of an instanced subobject points to the containing object, while the '''Outer''' property of "actual object" subobjects points to the class defining the subobject. An example for the latter case is the UT200x class [[UE2:Shark (UT2004)\|xEffects.Shark]], which creates a [[UE2:FinalBlend (UT2004)\|FinalBlend]] as a subobject and uses it as Skin.		Subobjects that are only templates are "instanced" (i.e. created) when an object of the class containing the subobject definition is created. Generally, the property '''Outer''' of an instanced subobject points to the containing object, while the '''Outer''' property of "actual object" subobjects points to the class defining the subobject. An example for the latter case is the UT200x class [[UE2:Shark (UT2004)\|xEffects.Shark]], which creates a [[UE2:FinalBlend (UT2004)\|FinalBlend]] as a subobject and uses it as Skin.

@@ Line 13: / Line 13: @@
 ==Subobjects in exported source code==
-It is generally a good idea to be suspicious of any [[defaultproperties]] section in a [[UC file]] created by exporting scripts from a compiled package. This goes especially for subobjects!
+It is generally a good idea to be suspicious of any [[defaultproperties]] section in a [[UC File|UC file]] created by exporting scripts from a compiled package. This goes especially for subobjects!
 Subobject definitions may not get exported at all in early [[Unreal Engine 2]] implementations. In newer versions subobjects will only be exported if they are either assigned to at least one property declared with the [[Variables#Modifiers|modifier]] '''export''' or if a property they are assigned to is of a type that is declared as '''instanced'''. For example a tooltip object assigned to the [[UE2:GUIComponent properties (UT2004)#ToolTip|GUIComponent.ToolTip]] property would get exported because the property's type is [[UE2:GUIToolTip (UT2004)|GUIToolTip]], a subclass of [[UE2:GUI (UT2004)|GUI]], which is declared with the '''instanced''' class modifier. Any karma parameter subobject assigned to the [[UE2:Actor properties (UT2004)#KParams|Actor.KParams]] property would be exported because that property is declared with the '''export''' variable modifier.

@@ Line 17: / Line 17: @@
 Subobject definitions may not get exported at all in early [[Unreal Engine 2]] implementations. In newer versions subobjects will only be exported if they are either assigned to at least one property declared with the [[Variables#Modifiers|modifier]] '''export''' or if a property they are assigned to is of a type that is declared as '''instanced'''. For example a tooltip object assigned to the [[UE2:GUIComponent properties (UT2004)#ToolTip|GUIComponent.ToolTip]] property would get exported because the property's type is [[UE2:GUIToolTip (UT2004)|GUIToolTip]], a subclass of [[UE2:GUI (UT2004)|GUI]], which is declared with the '''instanced''' class modifier. Any karma parameter subobject assigned to the [[UE2:Actor properties (UT2004)#KParams|Actor.KParams]] property would be exported because that property is declared with the '''export''' variable modifier.
-Subobjects in [[Unreal Engine 3]] are only exported if the subobject's class is a subclass of [[UE3:Component (UT3)|Component]]. A prominent example of this behavior is the [[UE3:UIObject (UT3)|UIObject]] class. Its subobject WidgetInitializedEvent is not exported because it's a [[UE3:UIEvent_Initialized (UT3)|UIEvent_Initialized]], which is not a Component subclass, while its other subobject [[UE3:UIObject (UT3)#WidgetEventComponent|WidgetEventComponent]] (class [[UE3:UIComp_Event (UT3)|UIComp_Event]]) is exported.
+Subobjects in [[Unreal Engine 3]] are only exported if the subobject's class is a subclass of [[UE3:Component (UT3)|Component]]. A prominent example of this behavior is the [[UE3:UIObject (UT3)|UIObject]] class. Its subobject WidgetInitializedEvent is not exported because it's a [[UE3:UIEvent_Initialized (UT3)|UIEvent_Initialized]], which is not a Component subclass, while its other subobject [[UE3:UIObject (UT3)#WidgetEventComponent|WidgetEventComponent]] (class [[UE3:UIComp_Event (UT3)|UIComp_Event]]) is exported.<br/>
 As you can see, it's always a good idea to have a look at the original (downloaded, not exported) sources if you want to find out about subobject usage.
 {{navbox unrealscript}}

← Older revision	Revision as of 21:04, 10 May 2008
(No difference)