Anvil
Anvil.Services.TargetModeSettings Class Reference

Configuration options for target mode. See NwPlayer.EnterTargetMode, NwPlayer.TryEnterTargetMode. More...

Properties

MouseCursor BadCursorType = MouseCursor.NoMagic [get, set]
 Gets or sets the type of cursor to show if the player is hovering over an invalid target. More...
 
MouseCursor CursorType = MouseCursor.Magic [get, set]
 Gets or sets the type of cursor to show if the player is hovering over a valid target. More...
 
TargetingDataTargetingData = null [get, set]
 Gets or sets overlay targeting data used to represent the effect generated by this target. More...
 
ObjectTypes ValidTargets = ObjectTypes.All [get, set]
 Gets or sets the type of objects that are valid for selection.
ObjectTypes is a flags enum, so multiple types may be specified using the OR operator (ObjectTypes.Creature | ObjectTypes.Placeable). More...
 

Detailed Description

Configuration options for target mode. See NwPlayer.EnterTargetMode, NwPlayer.TryEnterTargetMode.

Property Documentation

◆ BadCursorType

MouseCursor Anvil.Services.TargetModeSettings.BadCursorType = MouseCursor.NoMagic
getset

Gets or sets the type of cursor to show if the player is hovering over an invalid target.

◆ CursorType

MouseCursor Anvil.Services.TargetModeSettings.CursorType = MouseCursor.Magic
getset

Gets or sets the type of cursor to show if the player is hovering over a valid target.

◆ TargetingData

TargetingData? Anvil.Services.TargetModeSettings.TargetingData = null
getset

Gets or sets overlay targeting data used to represent the effect generated by this target.

◆ ValidTargets

ObjectTypes Anvil.Services.TargetModeSettings.ValidTargets = ObjectTypes.All
getset

Gets or sets the type of objects that are valid for selection.
ObjectTypes is a flags enum, so multiple types may be specified using the OR operator (ObjectTypes.Creature | ObjectTypes.Placeable).


The documentation for this class was generated from the following file: