TextStudioEffectMetadata
public sealed class TextStudioEffectMetadataImmutable discovery and parameter metadata for one effect definition.
Constructors
Section titled “Constructors”
TextStudioEffectMetadata(string, string, string, string, TextStudioPhaseMask, IReadOnlyList, TextStudioEffectPlaybackRole, TextStudioEffectPlaybackPreset, TextStudioEffectCurvePreset, float, float)
Section titled “TextStudioEffectMetadata(string, string, string, string, TextStudioPhaseMask, IReadOnlyList, TextStudioEffectPlaybackRole, TextStudioEffectPlaybackPreset, TextStudioEffectCurvePreset, float, float)”public TextStudioEffectMetadata(string category, string displayName, string description, string markupSnippet, TextStudioPhaseMask suggestedPhases, IReadOnlyList<TextStudioTagParameterDefinition> parameters = null, TextStudioEffectPlaybackRole playbackRole = TextStudioEffectPlaybackRole.Envelope, TextStudioEffectPlaybackPreset defaultPlayback = TextStudioEffectPlaybackPreset.External, TextStudioEffectCurvePreset defaultCurve = TextStudioEffectCurvePreset.Hold, float defaultPlaybackDuration = 1, float defaultDelayBetweenCycles = 0)Creates immutable authoring metadata in the supplied parameter display order.
Parameters
| Name | Type |
|---|---|
category |
System.String |
displayName |
System.String |
description |
System.String |
markupSnippet |
System.String |
suggestedPhases |
TextStudio.TextStudioPhaseMask |
parameters |
System.Collections.Generic.IReadOnlyList{TextStudio.TextStudioTagParameterDefinition} |
playbackRole |
TextStudio.TextStudioEffectPlaybackRole |
defaultPlayback |
TextStudio.TextStudioEffectPlaybackPreset |
defaultCurve |
TextStudio.TextStudioEffectCurvePreset |
defaultPlaybackDuration |
System.Single |
defaultDelayBetweenCycles |
System.Single |
Properties
Section titled “Properties”
Category
Section titled “Category”public string Category { get; }Returns
System.String
DisplayName
Section titled “DisplayName”public string DisplayName { get; }Returns
System.String
Description
Section titled “Description”public string Description { get; }Returns
System.String
MarkupSnippet
Section titled “MarkupSnippet”public string MarkupSnippet { get; }Returns
System.String
SuggestedPhases
Section titled “SuggestedPhases”public TextStudioPhaseMask SuggestedPhases { get; }Returns
TextStudio.TextStudioPhaseMask
PlaybackRole
Section titled “PlaybackRole”public TextStudioEffectPlaybackRole PlaybackRole { get; }Returns
TextStudio.TextStudioEffectPlaybackRole
DefaultPlayback
Section titled “DefaultPlayback”public TextStudioEffectPlaybackPreset DefaultPlayback { get; }Returns
TextStudio.TextStudioEffectPlaybackPreset
DefaultCurve
Section titled “DefaultCurve”public TextStudioEffectCurvePreset DefaultCurve { get; }Returns
TextStudio.TextStudioEffectCurvePreset
DefaultPlaybackDuration
Section titled “DefaultPlaybackDuration”public float DefaultPlaybackDuration { get; }Returns
System.Single
DefaultDelayBetweenCycles
Section titled “DefaultDelayBetweenCycles”public float DefaultDelayBetweenCycles { get; }Returns
System.Single
Parameters
Section titled “Parameters”public IReadOnlyList<TextStudioTagParameterDefinition> Parameters { get; }Returns
System.Collections.Generic.IReadOnlyList{TextStudio.TextStudioTagParameterDefinition}