Class EffectExtensions

Namespace

SunSharp

Assembly

SunSharp.dll

public static class EffectExtensions

Inheritance

object

EffectExtensions

Methods

ChangesTempo(Effect)

Determines whether the specified effect changes the tempo.

public static bool ChangesTempo(this Effect effect)

Parameters

effect Effect

Returns

bool

Remarks

Tempo-changing effects are those that modify the speed or BPM (beats per minute) of the playback.

IsDestructive(Effect)

Determines whether the specified effect is destructive.

public static bool IsDestructive(this Effect effect)

Parameters

effect Effect

Returns

bool

Remarks

Destructive effects are those that can remove or overwrite existing data in the pattern, potentially leading to loss of information. The effects considered destructive include deleting events, shifting track lines, generating polyrhythms, copying tracks, and writing random values.

IsEventDelay(Effect)

Determines whether the specified effect is an event delay effect.

public static bool IsEventDelay(this Effect effect)

Parameters

effect Effect

Returns

bool

Remarks

Event delay effects (0x40 to 0x5F) delay an event for a selected fraction of the line, from 0% to 96.875%.

IsNonLinear(Effect)

Determines whether the specified effect is non-linear.

public static bool IsNonLinear(this Effect effect)

Parameters

effect Effect

Returns

bool

Remarks

Non-linear effects are those that alter the normal sequential flow of pattern playback, such as jumps or stops, rather than modifying the sound or parameters of the notes being played.