TextGenerator Class

Summary

[Editor-Only] An Weaver.Editor.Procedural.AssetGenerator which saves UnityEngine.TextAssets as ".txt" text files.
Assembly
Weaver.dll
Namespace
Weaver.Editor.Procedural
Base Types
Derived Types
graph BT Type-->Base0["AssetGenerator"] click Base0 "/weaver/api/Weaver.Editor.Procedural/AssetGenerator" Base0-->Base1["Object"] Type["TextGenerator"] class Type type-node Derived0["ScriptGenerator"]-->Type click Derived0 "/weaver/api/Weaver.Editor.Procedural/ScriptGenerator"

Syntax

[AssetGenerator(typeof(TextAsset))]
public class TextGenerator : AssetGenerator

Attributes

Type Description
AssetGeneratorAttribute [Editor-Only] Specifies which asset type can be generated by the attributed class (which must inherit from Weaver.Editor.Procedural.AssetGenerator).

Properties

Name Value Summary
DefaultFileExtension string
.txt
GeneratorMethodParameterTypes Type[]
The parameter types of a generator method for this asset type. When overriding this property, consider using Weaver.ReflectionUtilities.OneType(System.Type) or Weaver.ReflectionUtilities.TwoTypes(System.Type,System.Type).
GeneratorMethodReturnType Type
The default return type for generator methods used by this generator.
HowToCancel string
Explains how to cancel the generation of an asset.

Methods

Name Value Summary
AddItemsToMenu(GenericMenu, ProceduralAsset) void
Populates `menu` with various items for the context menu of `asset`.
Inherited from AssetGenerator
AppendFullDescription(StringBuilder) void
Appends the full description of this Weaver.Editor.Procedural.AssetGenerator and how it is to be used.
Inherited from AssetGenerator
AppendHeader(StringBuilder, ProceduralAsset) void
Override to append any default text at the top of every file.
Destroy(Object) void
Destroys the specified `obj`.
Inherited from AssetGenerator
GetAssetPathAndDestroyOldSubAssets(ProceduralAsset) string
Gets the asset path of the existing asset and destroys all of its sub-assets.
Inherited from AssetGenerator
GetGeneratorMethod(MemberInfo) MethodInfo
Attempts to find the generator method assofiated with `assetField`.
Inherited from AssetGenerator
GetGeneratorMethod(MemberInfo, string) MethodInfo
Finds the generator method associated with a particular procedural asset.
Inherited from AssetGenerator
GetMethod(MemberInfo, string, Type[]) MethodInfo
Finds the generator method associated with a particular procedural asset.
Inherited from AssetGenerator
InvokeGeneratorMethod(ProceduralAsset) Object
Invokes `asset.GeneratorMethod` with the correct parameters for this Weaver.Editor.Procedural.AssetGenerator.
OnSaveText(ProceduralAsset) void
Called after the asset is saved.
Save(Object, string, bool) void
Does nothing because UnityEngine.TextAssets are saved inside Weaver.Editor.Procedural.TextGenerator.InvokeGeneratorMethod(Weaver.Editor.Procedural.ProceduralAsset).
SaveAndRelease(StringBuilder, string) void
Writes the contents of the `text` to the specified file `path` and releases the System.Text.StringBuilder for later reuse.
static
SaveDefaultAsset(string) void
Creates and saves an empty default asset to save sub assets inside while the asset is still generating.
Inherited from AssetGenerator
UseTempScene(ProceduralAsset) bool
Indicates whether a temporary scene should be opened while generating the specified `asset`. Default is false.
Inherited from AssetGenerator
ValidateGeneratorReturnType(Type) bool
Checks if return type of a generator method is valid for this generator type.
Inherited from AssetGenerator