Get RAPTOR

RaptorProjectChange

A project-wide change declared by a core feature or module.

NamespaceAssemblyKindStability
Raptor.EditorToolsRaptor.Editorclasspreview, since 0.1.0

Declare it with RaptorProjectChanges.Declare.

public sealed class RaptorProjectChange

Constructors

RaptorProjectChange

public RaptorProjectChange(string id, string word, string tooltip, Func<bool> isApplied, Action apply)

Creates a change declaration.

ParameterTypeDescription
idstringUnique id (letters, digits, '.', '_' and '-').
wordstringOne word for the Setup row (no spaces).
tooltipstringWhat the change writes (may be null).
isAppliedFunc<bool>Returns true when the change is in effect.
applyActionPerforms the change.

Properties

Apply

public Action Apply { get; }

Gets the action that performs the change. Called only by RaptorProjectChanges.Apply.

Id

public string Id { get; }

Gets the unique id (letters, digits, '.', '_' and '-'). Also used as the consent key's suffix.

IsApplied

public Func<bool> IsApplied { get; }

Gets the check that returns true when the change is already in effect in this project. It must not write anything.

Tooltip

public string Tooltip { get; }

Gets the row's tooltip, which describes what the change writes.

Word

public string Word { get; }

Gets the one-word label for the Setup page row.