Interface IEffectsSink

Namespace

MoonBark.GridPlacement.Core.Interfaces

Assembly

MoonBark.GridPlacement.Core.dll

Interface for visual effects in the placement system. Handles preview rendering, feedback effects, and visual indicators.

public interface IEffectsSink

Methods

CancelManipulation()

Cancels the current manipulation operation.

void CancelManipulation()

CancelPlacement()

Cancels the current placement operation.

void CancelPlacement()

ClearIndicator()

Clears the current indicator.

void ClearIndicator()

ClearPreview()

Clears the current preview.

void ClearPreview()

CommitManipulation()

Commits the current manipulation operation.

void CommitManipulation()

CommitPlacement()

Commits the current placement operation.

void CommitPlacement()

EnsurePreviewExists(PlaceableId)

Ensures a preview exists for the specified placeable.

void EnsurePreviewExists(PlaceableId placeableId)

Parameters

placeableId PlaceableId

ID of the placeable to preview.

PlayFeedback(FeedbackId)

Plays a feedback effect (e.g., placement success sound, error animation).

void PlayFeedback(FeedbackId feedbackId)

Parameters

feedbackId FeedbackId

ID of the feedback effect to play.

ShowIndicator(object)

Shows an indicator at the specified location.

void ShowIndicator(object indicatorData)

Parameters

indicatorData object

Data for the indicator to show.

StartManipulation(object)

Starts a manipulation operation.

void StartManipulation(object manipulationData)

Parameters

manipulationData object

Data for the manipulation to start.

UpdateManipulation(object)

Updates an ongoing manipulation operation.

void UpdateManipulation(object manipulationData)

Parameters

manipulationData object

Data to update the manipulation with.

UpdatePreview(object)

Updates the preview with new data.

void UpdatePreview(object previewData)

Parameters

previewData object

Data to update the preview with.