I don't need to test my programs. I have an error-correcting modem.

Difference between revisions of "Metadata"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (forgot navbox :/)
(Moved documentation of AutoComment from New UnrealScript in UT3 to here etc.)
Line 1: Line 1:
Starting with [[Unreal Engine 3]] UnrealScript supports Metadata for [[Variables]] which are used by [[UnrealEd]] to help out mappers to understand more about the variable by setting a friendly name for your variables and adding comments.
+
Starting with [[Unreal Engine 3]] UnrealScript supports Metadata for [[Variables]] which are used by [[UnrealEd]] to help out L.D.S (and any other kind of artists that use [[UnrealEd]]) to understand more about the variable by setting a friendly name for your variables and adding comments.
 
{{Expand}}
 
{{Expand}}
  
Line 5: Line 5:
 
Metatags can be added for almost any variable type some of them are [[struct]]'s, [[enum]] members and [[variables]].
 
Metatags can be added for almost any variable type some of them are [[struct]]'s, [[enum]] members and [[variables]].
  
A metatag is placed at the end of variable before the final semi colon like:
+
A metatag is placed at the end of a variable before the final semi colon like:
  '''var''' ''[[Variables#Modifiers|[modifiers]]]'' [[type]] variablename<''[[#Tags|[tag]]]''=[[Literals|[value]]]>''''';'''
+
  '''var''' ''[[Variables#Modifiers|[modifiers]]]'' [[type]] variablename<''[[#Tags|tag]]''=[[Literals|value]]>''''';'''
  
 
You can also declare more than one metatag by separating them with | like:
 
You can also declare more than one metatag by separating them with | like:
  '''var''' ''[[Variables#Modifiers|[modifiers]]]'' [[type]] variablename<''[[#Tags|[tag1]]]''=[[Literals|[value]]]|''[[#Tags|[tag2]]]''=[[Literals|[value]]]>''''';'''
+
  '''var''' ''[[Variables#Modifiers|[modifiers]]]'' [[type]] variablename<''[[#Tags|tag1]]''=[[Literals|value]]|''[[#Tags|tag2]]''=[[Literals|value]]>''''';'''
  
 
==Tags==
 
==Tags==
Line 20: Line 20:
 
;''[[Variable]]'' EditCondition<sup>3</sup>: Makes the variable non-editable in [[UnrealEd]] if the specified value of this tag is false, and editable if the specified value of this tag is true.
 
;''[[Variable]]'' EditCondition<sup>3</sup>: Makes the variable non-editable in [[UnrealEd]] if the specified value of this tag is false, and editable if the specified value of this tag is true.
 
;''[[Bool]]'' AllowAbstract<sup>3</sup>: Specifies whether the user can select abstract classes from the [[UnrealEd]] drop-down list.
 
;''[[Bool]]'' AllowAbstract<sup>3</sup>: Specifies whether the user can select abstract classes from the [[UnrealEd]] drop-down list.
{{Expand}}
+
**Limitations : Only works for variables of type class<...>. {{confirm}}
;''[[Bool]]'' AutoComment<sup>3</sup>:
+
;''[[Bool]]'' AutoComment<sup>3</sup>: The effect of this tag seems to be that the tagged variable's value is displayed in the sequence object's comment in the [[Legacy:Kismet|Kismet]] editor.
;''[[Bool]]'' FullyExpand<sup>+3</sup>?:
+
**Limitations : Apparently this tag only works in [[Legacy:SequenceObject|SequenceObject]] classes and also only if the class's bSuppressAutoComment property is set to false.
 +
;''[[Bool]]'' FullyExpand<sup>+3</sup>?: Expand all sub nodes of this variable when expanded. {{confirm|This is guessed and not tested therefor tagged confirm}}
 +
**Limitations : Only works for variables of type struct or editinline variables. {{confirm}}
  
 
{{navbox unrealscript}}
 
{{navbox unrealscript}}

Revision as of 11:54, 22 April 2010

Starting with Unreal Engine 3 UnrealScript supports Metadata for Variables which are used by UnrealEd to help out L.D.S (and any other kind of artists that use UnrealEd) to understand more about the variable by setting a friendly name for your variables and adding comments.


Declaration

Metatags can be added for almost any variable type some of them are struct's, enum members and variables.

A metatag is placed at the end of a variable before the final semi colon like:

var [modifiers] type variablename<tag=value>;

You can also declare more than one metatag by separating them with | like:

var [modifiers] type variablename<tag1=value|tag2=value>;

Tags

  • 3 – The tag is available in Unreal Engine 3.
  • 3+ – The tag is available in later Unreal Engine 3 versions, such as the UDK.
  • (no number) – The tag is available in all Unreal Engine generations.


String ToolTip3
Sets the ToolTip description to show in the UnrealEd's properties window, you can also add a /** ... */ comment above the variable's declaration and the UnrealScript compiler will automatic use that as ToolTip however you can still use the ToolTip tag to override the automatic set ToolTip.
String DisplayName3
Sets the variable's name to the specified DisplayName value in UnrealEd.
Variable EditCondition3
Makes the variable non-editable in UnrealEd if the specified value of this tag is false, and editable if the specified value of this tag is true.
Bool AllowAbstract3
Specifies whether the user can select abstract classes from the UnrealEd drop-down list.
    • Limitations : Only works for variables of type class<...>. [confirm]
Bool AutoComment3
The effect of this tag seems to be that the tagged variable's value is displayed in the sequence object's comment in the Kismet editor.
    • Limitations : Apparently this tag only works in SequenceObject classes and also only if the class's bSuppressAutoComment property is set to false.
Bool FullyExpand+3?
Expand all sub nodes of this variable when expanded. [confirm]
    • Limitations : Only works for variables of type struct or editinline variables. [confirm]