Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

Difference between revisions of "Metadata"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (→‎Tags: Added MultilineWithMaxRows)
(Improved descriptions)
Line 1: Line 1:
−
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.
+
Starting with [[Unreal Engine 3]] UnrealScript supports Metadata for [[Variables]]. By adding Metatags [[UnrealEd]] can behave different on variables by providing additional information of variables such as the semantics of variables, friendly names, interaction, visual appearance and behavior etc, to any of its users.
−
{{Expand}}
+
  
 
==Declaration==
 
==Declaration==
Line 14: Line 13:
 
* <sup>3</sup> &ndash; The tag is available in [[Unreal Engine 3]].
 
* <sup>3</sup> &ndash; The tag is available in [[Unreal Engine 3]].
 
* <sup>3+</sup> &ndash; The tag is available in later [[Unreal Engine 3]] versions, such as the [[UDK]].
 
* <sup>3+</sup> &ndash; The tag is available in later [[Unreal Engine 3]] versions, such as the [[UDK]].
 +
{{todo|
 +
* Describe the '''???''' tags
 +
* Test the tags in older Unreal Engine versions such as UT3 and early UDK builds
 +
* Add additional information and image examples for UI behavior affecting tags
 +
}}
 
<br>
 
<br>
−
;''[[String]]'' ToolTip<sup>3</sup>: 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.
+
;''[[Bool]]'' AllowAbstract<sup>3</sup>: Specifies whether the user can select abstract classes from the UnrealEd drop-down list.
−
;''[[String]]'' DisplayName<sup>3</sup>: Sets the variable's name to the specified DisplayName value in [[UnrealEd]].
+
−
;''[[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.
+
 
:Limitations: Only works for variables of type class<...>. {{confirm}}
 
:Limitations: Only works for variables of type class<...>. {{confirm}}
 +
;''[[Array]]'' ArrayClamp<sup>3+</sup>: The max value of this variable is specified dynamically by the specified array's length. This is useful if you want to let the developer set a Index value but the index value cannot be higher than the specified array's length. {{confirm}}
 
;''[[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 [[Kismet]] editor.
 
;''[[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 [[Kismet]] editor.
−
:Limitations: Apparently this tag only works in {{classgames|SequenceObject}} classes and also only if the class's bSuppressAutoComment property is set to false.
+
:Limitations: Apparently this tag only works in {{classgames|SequenceObject}} classes and if the class's '''bSuppressAutoComment''' property is set to false.
−
;''[[Bool]]'' FullyExpand<sup>3+</sup>{{confirm|Not tested in UT3}}: Expand all sub nodes of this variable when expanded. {{confirm|This is guessed and not tested therefor tagged confirm}}
+
;''[[Int]]'' ClampMax<sup>3+</sup>: The maximum value the variable value can be set to. See '''UIMax''' for a user limit. {{confirm}}
−
:Limitations: Only works for variables of type [[struct]] or [[editinline]] variables. {{confirm}}
+
;''[[Int]]'' ClampMin<sup>3+</sup>: The minimum value the variable value can be set to. See '''UIMin''' for a user limit. {{confirm}}
−
;''[[Float]]'' UIMin<sup>3+</sup>{{confirm|Not tested in UT3}}: The min value a user can input when editing this variable from a UI(User Interface).
+
;''[[String]]'' DisplayName<sup>3</sup>: The variable's name to be used for in UnrealEd. e.g. instead of displaying as "bThisIsABoolean" you can set the '''DisplayName''' to "This Is A Boolean" for ease reading.
−
;''[[Float]]'' UIMax<sup>3+</sup>{{confirm|Not tested in UT3}}: The max value a user can input when editing this variable from a UI(User Interface).
+
−
;''[[Array]]'' ArrayClamp<sup>3+</sup>{{confirm|Not tested in UT3}}: The max value of this variable is specified dynamicly by the specified array's length. This is useful if you want to let the developer set a Index value but the index value cannot be higher than the specified array's length. {{confirm}}
+
−
;''[[Int]]'' FixedIncrement<sup>3+</sup>{{confirm|Not tested in UT3}}: Increment the value of this variable by the specified increment value. {{confirm}}
+
−
;''[[Int]]'' OrderIndex<sup>3+</sup>: Automatic set by the compiler if the variable is editable. {{confirm}}
+
−
;''[[Int]]'' ClampMin<sup>3+</sup>{{confirm|Not tested in UT3}}: '''???'''.
+
−
;''[[Int]]'' ClampMax<sup>3+</sup>{{confirm|Not tested in UT3}}: '''???'''
+
−
;''[[Int]]'' Multiple<sup>3+</sup>{{confirm|Not tested in UT3}}: '''???'''.
+
−
;''[[Bool]]'' ScriptOrder<sup>3+</sup>{{confirm|Not tested in UT3}}: '''???'''.
+
−
;''[[Int]]'' MaxPropertyDepth<sup>3+</sup>{{confirm|Not tested in UT3}}: '''???'''.
+
−
;''[[Bool]]'' RealTime<sup>3+</sup>{{confirm|Not tested in UT3,Found in Dec(09) build of UDK but not in May build so needs a test}}: '''???'''.
+
 
;''[[Bool]]'' DMCOnly<sup>3+</sup>{{confirm|August}}: Unknown. Probably related to collision. Found in <code>PrimitiveComponent.uc</code>.
 
;''[[Bool]]'' DMCOnly<sup>3+</sup>{{confirm|August}}: Unknown. Probably related to collision. Found in <code>PrimitiveComponent.uc</code>.
 +
;''[[Variable]]'' EditCondition<sup>3</sup>: The variable with this tag can only be edited in UnrealEd if the set condition is true.
 +
;''[[Int]]'' FixedIncrement<sup>3+</sup>: Increment the value of this variable by the specified increment value. {{confirm}}
 +
;''[[Bool]]'' FullyExpand<sup>3+</sup>: To be applied to [[structs]] or [[editinline]] variables. When expanded all children nodes will be expanded as well. {{confirm|This is guessed and not tested therefor tagged confirm}}
 +
;''[[Int]]'' MaxPropertyDepth<sup>3+</sup>: '''???'''.
 
;''[[Int]]'' MultilineWithMaxRows<sup>3+</sup>{{confirm|October}}: '''???'''.
 
;''[[Int]]'' MultilineWithMaxRows<sup>3+</sup>{{confirm|October}}: '''???'''.
 +
;''[[Int]]'' Multiple<sup>3+</sup>: '''???'''.
 +
;''[[Int]]'' OrderIndex<sup>3+</sup>: Auto applied to editable variables by the compiler. {{confirm}}
 +
;''[[Bool]]'' RealTime<sup>3+</sup>{{confirm|Not tested in UT3,Found in Dec(09) build of UDK but not in May build so needs a test}}: '''???'''.
 +
;''[[Bool]]'' ScriptOrder<sup>3+</sup>: '''???'''.
 +
;''[[String]]'' ToolTip<sup>3</sup>: 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 automatically use that as the ToolTip description , however you can still use the ToolTip tag to override the automatically set ToolTip description.
 +
;''[[Float]]'' UIMax<sup>3+</sup>: The maximum value a user can input when editing the variable from an User Interface. See '''ClampMax''' for a UnrealEd limit. {{confirm}}
 +
;''[[Float]]'' UIMin<sup>3+</sup>: The minimum value a user can input when editing the variable from an User Interface. See '''ClampMin''' for a UnrealEd limit. {{confirm}}
  
 
{{navbox unrealscript}}
 
{{navbox unrealscript}}

Revision as of 19:40, 10 November 2010

Starting with Unreal Engine 3 UnrealScript supports Metadata for Variables. By adding Metatags UnrealEd can behave different on variables by providing additional information of variables such as the semantics of variables, friendly names, interaction, visual appearance and behavior etc, to any of its users.

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

The following things need to be done on this page or in this section:
  • Describe the ??? tags
  • Test the tags in older Unreal Engine versions such as UT3 and early UDK builds
  • Add additional information and image examples for UI behavior affecting tags


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]
Array ArrayClamp3+
The max value of this variable is specified dynamically by the specified array's length. This is useful if you want to let the developer set a Index value but the index value cannot be higher than the specified array's length. [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(UDK, UT3) classes and if the class's bSuppressAutoComment property is set to false.
Int ClampMax3+
The maximum value the variable value can be set to. See UIMax for a user limit. [confirm]
Int ClampMin3+
The minimum value the variable value can be set to. See UIMin for a user limit. [confirm]
String DisplayName3
The variable's name to be used for in UnrealEd. e.g. instead of displaying as "bThisIsABoolean" you can set the DisplayName to "This Is A Boolean" for ease reading.
Bool DMCOnly3+[confirm]
Unknown. Probably related to collision. Found in PrimitiveComponent.uc.
Variable EditCondition3
The variable with this tag can only be edited in UnrealEd if the set condition is true.
Int FixedIncrement3+
Increment the value of this variable by the specified increment value. [confirm]
Bool FullyExpand3+
To be applied to structs or editinline variables. When expanded all children nodes will be expanded as well. [confirm]
Int MaxPropertyDepth3+
???.
Int MultilineWithMaxRows3+[confirm]
???.
Int Multiple3+
???.
Int OrderIndex3+
Auto applied to editable variables by the compiler. [confirm]
Bool RealTime3+[confirm]
???.
Bool ScriptOrder3+
???.
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 automatically use that as the ToolTip description , however you can still use the ToolTip tag to override the automatically set ToolTip description.
Float UIMax3+
The maximum value a user can input when editing the variable from an User Interface. See ClampMax for a UnrealEd limit. [confirm]
Float UIMin3+
The minimum value a user can input when editing the variable from an User Interface. See ClampMin for a UnrealEd limit. [confirm]
Declarations Preprocessor • Classes • Interfaces • Cpptext • Constants • Enums • Structs • Variables (Metadata) • Replication block • Operators • Delegates • Functions • States • Defaultproperties (Subobjects)
Types bool • byte • float • int • name • string • Object • Class • Enums • Structs (Vector ⋅ Rotator ⋅ Quat ⋅ Color) • Static arrays • Dynamic arrays • Delegates • Typecasting
Literals Boolean • Float • Integer • Names • Objects (None ⋅ Self) • Vectors • Rotators • Strings
Flow GoTo • If • Assert • Return • Stop • Switch • While • Do...Until • For • ForEach • Break • Continue
Specifiers Super • Global • Static • Default • Const
UnrealScript Syntax • .UC • .UCI • .UPKG • Comments • #directives • Native
Retrieved from "https://wiki.beyondunreal.com/Metadata?oldid=44100"