s&box IResourcePreview: Resource preview interface

IResourcePreview Interface API Reference

IResourcePreview is an interface for GameResources that want to enable in-picker previewing. When the user clicks an item in the resource picker, OnPreview is called instead of immediately selecting it. A "Select" button confirms the choice.

Type Signature

public interface IResourcePreview
{
    void OnPreview();
    void OnPreviewStop();
}

Methods

OnPreview()

OnPreviewStop()

Usage

Implement on a GameResource to enable preview functionality:

[AssetType(Name = "Sound Definition", Extension = "sndef", Category = "Sandbox")]
public class SoundDefinition : GameResource, IResourcePreview
{
    [Property] public SoundEvent Sound { get; set; }

    private SoundHandle _previewHandle;

    public void OnPreview()
    {
        OnPreviewStop();

        if (Sound is null) return;
        _previewHandle = Sandbox.Sound.Play(Sound);
    }

    public void OnPreviewStop()
    {
        if (_previewHandle.IsValid())
        {
            _previewHandle.Stop();
            _previewHandle = default;
        }
    }
}

Notes

• Used by the resource picker to enable preview before selection
• OnPreview should stop any previous preview before starting a new one
• OnPreviewStop should clean up any preview resources
• Commonly used for sounds (play audio), models (show ghost), particles (spawn preview)
• Preview is shown in the resource picker UI