Home | API by Category | Complete API Index | API Status

Transforms borrowed glyph state during rich-text recording through a typed C# hook.

public class Electron2D.RichTextEffect

Labels borrow effects. A custom subtype implements the hook; BBCode names identify installed effects without per-glyph source lookup; compiled Script assets can construct exact typed effect subclasses. Processing takes place on the label's owner thread.

Inherits: Resource

Detailed engine reference

Kind: constructor

public RichTextEffect()

Creates an unnamed effect whose default hook leaves text untransformed.

Kind: method

protected override System.Void CopyCustomStateTo(Electron2D.Resource target, System.Boolean deep, Electron2D.DeepDuplicateMode mode, System.Func<Electron2D.Resource, Electron2D.Resource> duplicate, System.Func<Electron2D.Resource, Electron2D.Resource> force)

Kind: method

protected override Electron2D.Resource CreateDuplicateInstance()

Kind: method

protected override System.Collections.Generic.IEnumerable<Electron2D.PropertyDescriptor> GetPropertyDescriptors()

Kind: method

protected virtual System.Boolean OnProcessCustomFX(Electron2D.CharFXTransform charFX)

Transforms the current glyph state.

True when this transform succeeds; false stops later custom effects for that glyph.

• charFX: Borrowed state, reset for subsequent glyphs.

Kind: property

public System.String BBCode { get; set; }

Gets or sets this effect's tag identifier.

Empty initially; unnamed effects can still be pushed directly.