Summary
[Editor-Only]
Manages the details for building a constructor in a procedural C# script.
- Assembly
- Weaver
.dll - Namespace
- Weaver
.Editor .Procedural .Scripting - Base Types
-
- Object
- ElementBuilder
- MemberBuilder
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["ConstructorBuilder"]
class Type type-node
Syntax
public class ConstructorBuilder : MemberBuilder
Constructors
| Name | Summary |
|---|---|
| ConstructorBuilder |
Creates a new Weaver.Editor.Procedural.Scripting.ConstructorBuilder with 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 |
|---|---|---|
| Default |
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 |
|---|---|---|
| AppendBaseParameters | Action |
Appends the parameters passed into the base constructor, I.E.
"... : base(
Weaver.Editor.Procedural.Scripting.ConstructorBuilder.AppendBaseParameters)".
|
| Attribute |
Action |
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
|
| BodyBuilder | AppendFunction |
The delegate used to build the body of this method.
|
| CommentBuilder | Action |
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
|
| Compilation |
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
|
| ExistingConstructor | ConstructorInfo |
The
System.Reflection.ConstructorInfo of the method with the same parameters as this builder.
This property is gathered by Weaver.Editor.Procedural.Scripting.ConstructorBuilder.IsExistingMember(System.Reflection.MemberInfo,System.Boolean@).
|
| ExistingMember | MemberInfo |
The
System.Reflection.ConstructorInfo of the method with the same parameters as this builder.
This property is gathered by Weaver.Editor.Procedural.Scripting.ConstructorBuilder.IsExistingMember(System.Reflection.MemberInfo,System.Boolean@).
|
| 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.Constructor. |
| 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
|
| Parameters | ParameterBuilder[] |
This method's parameters. Corresponds to the
System.Reflection.MethodBase.GetParameters. |
| 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
|
Methods
| Name | Value | Summary |
|---|---|---|
| AppendDescription |
void |
Appends a description of this element by calling
Weaver.Editor.Procedural.Scripting.ElementBuilder.ToString on it.
Inherited from ElementBuilder
|
| AppendFullName |
void |
Appends 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
|
| AppendHeader |
void |
Appends a C# XML comment using the
Weaver.Editor.Procedural.Scripting.ElementBuilder.CommentBuilder followed by any
Weaver.Editor.Procedural.Scripting.MemberBuilder.Attributes.
Inherited from MemberBuilder
|
| AppendScript |
void |
Appends the declaration of this method in C# code to the specified `text`.
|
| DetermineMemberName |
void |
Uses the specified
Weaver.Editor.Procedural.Scripting.ScriptBuilder.GetMemberName(System.String,System.String,System.Boolean@) to determine the Weaver.Editor.Procedural.Scripting.ElementBuilder.Name of this element.
Inherited from ElementBuilder
|
| Get |
ConstructorBuilder |
Get a
Weaver.Editor.Procedural.Scripting.ConstructorBuilder from the object pool and initialize it with the specified parameters.
static
|
| Get |
ConstructorBuilder |
Get a
Weaver.Editor.Procedural.Scripting.ConstructorBuilder from the object pool and initialize it with the specified parameters.
static
|
| Get |
Action |
Returns the default method to use to build XML comments for this member. Called once by the constructor.
|
| GetDescription |
string |
Gets a description of this element by calling
Weaver.Editor.Procedural.Scripting.ElementBuilder.ToString on it and any sub-members.
Inherited from ElementBuilder
|
| Initialize |
void |
Assigns the specified parameters to this element and determines the
Weaver.Editor.Procedural.Scripting.ElementBuilder.Name.
Inherited from ElementBuilder
|
| IsExistingMember |
bool |
Checks if the
Weaver.Editor.Procedural.Scripting.ElementBuilder.Name, Weaver.Editor.Procedural.Scripting.MemberBuilder.Modifiers, and parameters match
the `existingMember`.
If the member matches, this method returns true and the member can be accessed via Weaver.Editor.Procedural.Scripting.ConstructorBuilder.ExistingMember.
|
| ReleaseToPool |
void |
Resets this element and adds it to its object pool to be reused later.
|
| Reset |
void |
Reset all of the fields and properties of this member to their default values.
|
| Set |
void |
Sets the
Weaver.Editor.Procedural.Scripting.MemberBuilder.AttributeConstructorBuilders array.Inherited from MemberBuilder
|
| SetAttributes |
void |
Sets the
Weaver.Editor.Procedural.Scripting.MemberBuilder.Attributes array.Inherited from MemberBuilder
|
| SetName |
void |
Sets the
Weaver.Editor.Procedural.Scripting.ElementBuilder.Name and Weaver.Editor.Procedural.Scripting.ElementBuilder.NameSource.Inherited from ElementBuilder
|
| ToString |
string |
Returns a summary of this element including its type,
Weaver.Editor.Procedural.Scripting.ElementBuilder.NameSource, Weaver.Editor.Procedural.Scripting.ElementBuilder.Name, and Weaver.Editor.Procedural.Scripting.ElementBuilder.FullName.
Inherited from ElementBuilder
|