Class HUDMassSelectionBase<TSelectable, TCoordinate>
- Namespace
- Root
- Assembly
- SPZGameAssembly.dll
public abstract class HUDMassSelectionBase<TSelectable, TCoordinate> : HUDPart, IHUDMassSelection where TSelectable : struct, IEquatable<TSelectable> where TCoordinate : struct
Type Parameters
TSelectable
TCoordinate
- Inheritance
-
object
Object
Component
Behaviour
MonoBehaviour
HUDMassSelectionBase<TSelectable, TCoordinate>
- Implements
-
- Derived
-
- Inherited Members
-
- Extension Methods
-
Constructors
HUDMassSelectionBase()
protected HUDMassSelectionBase()
Fields
IsPermittedToSelect
protected bool IsPermittedToSelect
Field Value
- bool
Properties
CurrentMode
public HUDMassSelectionMode CurrentMode { get; }
Property Value
- HUDMassSelectionMode
DialogStack
protected IHUDDialogStack DialogStack { get; }
Property Value
- IHUDDialogStack
NeedsGraphicsRaycaster
public override bool NeedsGraphicsRaycaster { get; }
Property Value
- bool
PassiveEventBus
protected IEventSender PassiveEventBus { get; }
Property Value
- IEventSender
PlayerActions
protected PlayerActionManager PlayerActions { get; }
Property Value
- PlayerActionManager
Selection
protected abstract ISelection<TSelectable> Selection { get; }
Property Value
- ISelection<TSelectable>
UISoundPlayer
protected IUISoundPlayer UISoundPlayer { get; }
Property Value
- IUISoundPlayer
Viewport
protected Viewport Viewport { get; }
Property Value
- Viewport
Methods
ClearCurrentSelection()
protected void ClearCurrentSelection()
ComputeCursorWorldPosition()
protected abstract float3 ComputeCursorWorldPosition()
Returns
- float3
ComputeEntriesInArea(TCoordinate, TCoordinate, HashSet<TSelectable>)
protected abstract void ComputeEntriesInArea(TCoordinate fromInclusive, TCoordinate toInclusive, HashSet<TSelectable> result)
Parameters
fromInclusive TCoordinate
toInclusive TCoordinate
result HashSet<TSelectable>
CreateDeleteAction(IReadOnlyCollection<TSelectable>)
protected abstract IPlayerAction CreateDeleteAction(IReadOnlyCollection<TSelectable> entries)
Parameters
entries IReadOnlyCollection<TSelectable>
Returns
- IPlayerAction
DeleteSelection(IReadOnlyCollection<TSelectable>)
protected void DeleteSelection(IReadOnlyCollection<TSelectable> selection)
Parameters
selection IReadOnlyCollection<TSelectable>
Draw_AreaSelection(FrameDrawOptions, TCoordinate, TCoordinate, HUDMassSelectionSelectionType)
protected abstract void Draw_AreaSelection(FrameDrawOptions options, TCoordinate from, TCoordinate to, HUDMassSelectionSelectionType type)
Parameters
options FrameDrawOptions
from TCoordinate
to TCoordinate
type HUDMassSelectionSelectionType
Draw_ExistingSelection(FrameDrawOptions, IReadOnlyCollection<TSelectable>)
protected abstract void Draw_ExistingSelection(FrameDrawOptions options, IReadOnlyCollection<TSelectable> selection)
Parameters
options FrameDrawOptions
selection IReadOnlyCollection<TSelectable>
Draw_HoverState(FrameDrawOptions, TSelectable, float)
protected abstract void Draw_HoverState(FrameDrawOptions options, TSelectable selection, float alpha)
Parameters
options FrameDrawOptions
selection TSelectable
alpha float
Draw_PendingSelection(FrameDrawOptions, IReadOnlyCollection<TSelectable>, HUDMassSelectionSelectionType)
protected abstract void Draw_PendingSelection(FrameDrawOptions options, IReadOnlyCollection<TSelectable> entities, HUDMassSelectionSelectionType type)
Parameters
options FrameDrawOptions
entities IReadOnlyCollection<TSelectable>
type HUDMassSelectionSelectionType
FindEntityBelowCursor()
protected abstract TSelectable FindEntityBelowCursor()
Returns
- TSelectable
GetTargetScopeState()
protected abstract PlayerInteractionState GetTargetScopeState()
Returns
- PlayerInteractionState
Hook_OnEntriesDeleted(IReadOnlyCollection<TSelectable>)
protected abstract void Hook_OnEntriesDeleted(IReadOnlyCollection<TSelectable> entries)
Parameters
entries IReadOnlyCollection<TSelectable>
IsRemovable(TSelectable)
protected abstract bool IsRemovable(TSelectable selectable)
Parameters
selectable TSelectable
Returns
- bool
OnDeleteSelection(IReadOnlyCollection<TSelectable>)
protected abstract void OnDeleteSelection(IReadOnlyCollection<TSelectable> selection)
Parameters
selection IReadOnlyCollection<TSelectable>
OnDeleteSelectionFail(IReadOnlyCollection<TSelectable>)
protected abstract void OnDeleteSelectionFail(IReadOnlyCollection<TSelectable> selection)
Parameters
selection IReadOnlyCollection<TSelectable>
OnDispose()
protected override void OnDispose()
OnEntriesAddedToSelection(IEnumerable<TSelectable>)
protected abstract void OnEntriesAddedToSelection(IEnumerable<TSelectable> entries)
Parameters
entries IEnumerable<TSelectable>
OnEntriesRemovedFromSelection(IEnumerable<TSelectable>)
protected abstract void OnEntriesRemovedFromSelection(IEnumerable<TSelectable> entries)
Parameters
entries IEnumerable<TSelectable>
OnGameUpdate(InputDownstreamContext, FrameDrawOptions)
public override void OnGameUpdate(InputDownstreamContext context, FrameDrawOptions drawOptions)
Parameters
context InputDownstreamContext
drawOptions FrameDrawOptions
OnHover(TSelectable)
protected abstract void OnHover(TSelectable target)
Parameters
target TSelectable
SpawnHoverAnimation(FrameDrawOptions, TSelectable)
protected void SpawnHoverAnimation(FrameDrawOptions options, TSelectable target)
Parameters
options FrameDrawOptions
target TSelectable
UpdateAreaSelectionRange(ref TCoordinate?, ref TCoordinate?, out bool)
protected abstract void UpdateAreaSelectionRange(ref TCoordinate? from, ref TCoordinate? to, out bool changed)
Parameters
from TCoordinate?
to TCoordinate?
changed bool
UpdateMode_Area(InputDownstreamContext, FrameDrawOptions, TSelectable)
protected void UpdateMode_Area(InputDownstreamContext context, FrameDrawOptions drawOptions, TSelectable selectableBelowCursor)
Parameters
context InputDownstreamContext
drawOptions FrameDrawOptions
selectableBelowCursor TSelectable
UpdateMode_None(InputDownstreamContext, FrameDrawOptions, TSelectable)
protected void UpdateMode_None(InputDownstreamContext context, FrameDrawOptions drawOptions, TSelectable selectableBelowCursor)
Parameters
context InputDownstreamContext
drawOptions FrameDrawOptions
selectableBelowCursor TSelectable
UpdateMode_QuickDelete(InputDownstreamContext, FrameDrawOptions, TSelectable)
protected void UpdateMode_QuickDelete(InputDownstreamContext context, FrameDrawOptions drawOptions, TSelectable selectableBelowCursor)
Parameters
context InputDownstreamContext
drawOptions FrameDrawOptions
selectableBelowCursor TSelectable
UpdateMode_Single(InputDownstreamContext, FrameDrawOptions, TSelectable)
protected void UpdateMode_Single(InputDownstreamContext context, FrameDrawOptions drawOptions, TSelectable selectableBelowCursor)
Parameters
context InputDownstreamContext
drawOptions FrameDrawOptions
selectableBelowCursor TSelectable