Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
This attribute is intended to be used on enum fields for enums that can be used in script files (.material, .overlay, etc). Placing this attribute on the field will allow the script parsers to look up a real enum value based on the value as it is used in the script.

Namespace: Visual3D.Assets.Importers.Ogre
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

      
 C#  Visual Basic 
public sealed class ScriptEnumAttribute : Attribute
Public NotInheritable Class ScriptEnumAttribute _
	Inherits Attribute

Members

               
 All Members  Constructors   Fields   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
ScriptEnumAttribute(String)
Initializes a new instance of the ScriptEnumAttribute class
AddEnumsEntry(Type, array<String>[]()[][])
GetLegalValues(Type)
Returns a string describing the legal values for a particular enum.
Lookup(String, Type)
Returns an actual enum value for a enum that can be used in script files.
ReportErrorsOnlyForDebugLog
ScriptTagName

Remarks

For example, texturing addressing mode can base used in .material scripts, and the values in the script are 'wrap', 'clamp', and 'mirror'.

The TextureAddress enum fields are defined with attributes to create the mapping between the scriptable values and their real enum values.

... [ScriptEnum("wrap")] Wrap ...

Inheritance Hierarchy

System..::..Object
  System..::..Attribute
    Visual3D.Assets.Importers.Ogre..::..ScriptEnumAttribute

See Also