Summary

[Editor-Only] Manages the details for building a field in a procedural C# script.

Assembly

Namespace

Weaver.Editor.Procedural.Scripting

Base Types

graph BT Type-->Base0["MemberBuilder"] click Base0 "/weaver/api/Weaver.Editor.Procedural.Scripting/MemberBuilder" Base0-->Base1["ElementBuilder"] click Base1 "/weaver/api/Weaver.Editor.Procedural.Scripting/ElementBuilder" Base1-->Base2["Object"] Type["FieldBuilder"] class Type type-node

Syntax

public class FieldBuilder : MemberBuilder

Constructors

Name	Summary
FieldBuilder()	Creates a new `Weaver.Editor.Procedural.Scripting.FieldBuilder` with the default values. Consider using one of the overloads of Get instead, in order to utilise object pooling to minimise memory allocation and garbage collection.

Fields

Name	Constant Value	Summary
DefaultAppendInitializer		The default delegate assigned to `Weaver.Editor.Procedural.Scripting.FieldBuilder.AppendInitializer`. It simply calls `Weaver.Editor.Procedural.Scripting.CSharpProcedural.GetInitializer(System.Object)` and appends the result if it isn't null. static
DefaultCommentBuilder		The default delegate to use to build the XML comment for this element. Assigned using the return value of `Weaver.Editor.Procedural.Scripting.ElementBuilder.GetDefaultCommentBuilder`. Inherited from ElementBuilder
DefaultModifiers		The default access modifiers for this member. Inherited from MemberBuilder

Properties

Name	Value	Summary
AppendInitializer	FieldBuilder.AppendInitializerMethod	A method which takes the following parameters and appends an appropriate field initializer: (`System.Text.StringBuilder` text, `int` indent, `System.Object` value). By default, `Weaver.Editor.Procedural.Scripting.CSharpProcedural.GetInitializer(System.Object)` will be used. Note that this delegate is called immediately after the field name and before the semicolon, so it must begin with " = " to assign a value and should not append a semicolon at the end.
AttributeConstructorBuilders	Action<StringBuilder>[]	The methods used to build the constructor of each custom attribute for this member. Inherited from MemberBuilder
Attributes	Type[]	The custom attribute types for this member. Inherited from MemberBuilder
CommentBuilder	Action<StringBuilder>	This delegate is used to append the XML comment for this element. By default it will simply append the `Weaver.Editor.Procedural.Scripting.ElementBuilder.NameSource`. Inherited from ElementBuilder
CompilationSymbolIndex	int	The index in `Weaver.Editor.Procedural.Scripting.ScriptBuilder.CompilationSymbols` of the symbol in which this element will be declared, I.E. #if SYMBOL. Inherited from ElementBuilder
ExistingField	FieldInfo	The `System.Reflection.FieldInfo` of the field with the same type and name as this builder. This property is gathered by `Weaver.Editor.Procedural.Scripting.FieldBuilder.IsExistingMember(System.Reflection.MemberInfo,System.Boolean@)`.
ExistingMember	MemberInfo	The `System.Reflection.FieldInfo` of the field with the same type and name as this builder. This property is gathered by `Weaver.Editor.Procedural.Scripting.FieldBuilder.IsExistingMember(System.Reflection.MemberInfo,System.Boolean@)`.
FieldType	TypeName	The type of object this field holds. Corresponds to `System.Reflection.FieldInfo.FieldType`.
FullName	string	Returns the full name of this element, including its `Weaver.Editor.Procedural.Scripting.ElementBuilder.Parent` (and any types and namespaces it is nested inside). Inherited from ElementBuilder
HasExistingMember	bool	Returns true if this element is associated with an existing `System.Reflection.MemberInfo`. Inherited from MemberBuilder
IsFallbackName	bool	Indicates whether the current `Weaver.Editor.Procedural.Scripting.ElementBuilder.Name` of this element is the primary name derived from the `Weaver.Editor.Procedural.Scripting.ElementBuilder.NameSource`. A value of false means that there was a name conflict between this element and another, and the `Weaver.Editor.Procedural.Scripting.ElementBuilder.Name` was re-derived using `Weaver.Editor.Procedural.Scripting.ScriptBuilder.GetFallbackMemberName(System.String,System.String)`. Inherited from ElementBuilder
MemberType	MemberTypes	This is a `System.Reflection.MemberTypes.Field`.
Modifiers	AccessModifiers	The access modifiers of this member. Inherited from MemberBuilder
Name	string	The actual `Weaver.Editor.Procedural.Scripting.ElementBuilder.Name` of this element. This value is derived from `Weaver.Editor.Procedural.Scripting.ElementBuilder.NameSource` during `Weaver.Editor.Procedural.Scripting.ElementBuilder.PrepareToBuild(System.Boolean,System.Boolean@)`. Inherited from ElementBuilder
NameSource	string	The source string which will be used to determine the actual `Weaver.Editor.Procedural.Scripting.ElementBuilder.Name` of this element. Inherited from ElementBuilder
Namespace	string	The name of the `Weaver.Editor.Procedural.Scripting.NamespaceBuilder` containing this type (or null if there isn't one). Inherited from ElementBuilder
Parent	IElementBuilderGroup	The builder of the type in which this element will be declared. Inherited from ElementBuilder
RegionIndex	int	The index in `Weaver.Editor.Procedural.Scripting.ScriptBuilder.Regions` of the region in which this element will be declared, I.E. #region Region Name. Inherited from ElementBuilder
ScriptBuilder	ScriptBuilder	The `Weaver.Editor.Procedural.Scripting.ScriptBuilder` in which this element is currently being used. Inherited from ElementBuilder
Value	Object	The initial value of the field.
ValueEquals	Func<Object, bool>	Used to check if the specified `System.Object` is equal to the `Weaver.Editor.Procedural.Scripting.FieldBuilder.Value` of this field when determining if the script needs to be rebuilt. If null, the check will be skipped.

Methods