Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ShowSelector

Opens a modal window to select a preset for a set of objects.
Read time 3 minutesLast updated 5 days ago

Definition

ShowSelector(Object[], Preset, bool)

Opens a modal window to select a preset for a set of objects.
public static void ShowSelector(Object[] targets, Preset currentSelection, bool createNewAllowed)

Parameters

targets

The objects that the selected preset applies to.

currentSelection

The preset to select when the window opens. Set to null for no selection.

createNewAllowed

Set to true to show the Create New Preset button. Set to false to hide it.

Remarks

The window lists the presets that apply to the target objects. To get notified when the selection changes or the window closes, use the overload that takes callbacks.

ShowSelector(Object[], Preset, bool, Action<Preset>, Action<Preset, bool>)

Opens a modal window to select a preset for a set of objects, with callbacks for selection changes and closing.
public static void ShowSelector(Object[] targets, Preset currentSelection, bool createNewAllowed, Action<Preset> onSelectionChanged, Action<Preset, bool> onSelectionClosed)

Parameters

targets

The objects that the selected preset applies to.

currentSelection

The preset to select when the window opens. Set to null for no selection.

createNewAllowed

Set to true to show the Create New Preset button. Set to false to hide it.

onSelectionChanged

The callback to invoke when the selected preset changes. It receives the selected preset.

onSelectionClosed

The callback to invoke when the window closes. It receives the selected preset and whether the user canceled the selection.

Remarks

The window lists the presets that apply to the target objects.

ShowSelector(Object, Preset, bool, PresetSelectorReceiver)

OBSOLETE. Opens a modal window to select a Preset.
Warning
Deprecated. The PresetSelectorReceiver is deprecated. Please use ShowSelector(Object[], Preset, bool).
public static void ShowSelector(Object target, Preset currentSelection, bool createNewAllowed, PresetSelectorReceiver eventReceiver)

Parameters

target

Object that identifies the type of Preset asset being selected. The modal window filters the selector view based on this object.

currentSelection

The selected Preset when the window is opened. Set to 'null' for no selection.

createNewAllowed

Whether to show the 'Create New Preset...' button. Set to true to show the button. Set to false to hide this button.

The PresetSelectorReceiver instance that the PresetSelector uses to send events.

ShowSelector(PresetType, Preset, bool, PresetSelectorReceiver)

OBSOLETE. Opens a modal window to select a Preset.
Warning
Deprecated. The PresetSelectorReceiver is deprecated. Please use ShowSelector(Object[], Preset, bool).
public static void ShowSelector(PresetType presetType, Preset currentSelection, bool createNewAllowed, PresetSelectorReceiver eventReceiver)

Parameters

presetType

Filters the list of Presets based on a specific PresetType. Use this param to set the PresetType when no target is specified.

currentSelection

The selected Preset when the window is opened. Set to 'null' for no selection.

createNewAllowed

Whether to show the 'Create New Preset...' button. Set to true to show the button. Set to false to hide this button.

The PresetSelectorReceiver instance that the PresetSelector uses to send events.

ShowSelector(PresetType, Preset, SerializedProperty, bool)

Opens a modal window to select a Preset from an object field backed by a SerializedProperty.
public static ISearchView ShowSelector(PresetType presetType, Preset currentSelection, SerializedProperty presetProperty, bool createNewAllowed)

Parameters

presetType

Filters the list of Presets based on a specific PresetType.

currentSelection

The selected Preset when the window is opened. Set to 'null' for no selection.

presetProperty

The SerializedProperty behind an ObjectField used to select preset assets.

createNewAllowed

Whether to show the 'Create New Preset...' button. Set to true to show the button. Set to false to hide this button.

Returns

Type

Description

ISearchViewReturns the search view.