Class InspectRegion
Used for creating regions the player can inspect. Useful for picking up items or talking to NPCs.
Inheritance
Object
Component
Behaviour
MonoBehaviour
InspectRegion
Namespace: WeaverCore.Components
Assembly: WeaverCore.dll
Syntax
public abstract class InspectRegion : MonoBehaviour
Fields
| Edit this page View SourceOnInspect
Event triggered when the region is inspected.
Declaration
public UnityEvent OnInspect
Field Value
Type | Description |
---|---|
UnityEvent |
heroLooksUp
Declaration
[SerializeField]
protected bool heroLooksUp
Field Value
Type | Description |
---|---|
bool |
promptPrefab
The prefab for the inspection prompt.
Declaration
[SerializeField]
[Tooltip("Prefab for the inspection prompt.")]
public WeaverArrowPrompt promptPrefab
Field Value
Type | Description |
---|---|
WeaverArrowPrompt |
Properties
| Edit this page View SourceEnableKnightDamageInterrupt
Declaration
public bool EnableKnightDamageInterrupt { get; set; }
Property Value
Type | Description |
---|---|
bool |
FullyInspected
Is set to true if the region has been fully inspected.
Declaration
public bool FullyInspected { get; protected set; }
Property Value
Type | Description |
---|---|
bool |
Inspectable
Declaration
public bool Inspectable { get; set; }
Property Value
Type | Description |
---|---|
bool |
PlayerInRange
Is set to true if the player is currently within range of inspecting.
Declaration
public bool PlayerInRange { get; }
Property Value
Type | Description |
---|---|
bool |
PlayerInspecting
Is set to true if the player is currently inspecting.
Declaration
public bool PlayerInspecting { get; }
Property Value
Type | Description |
---|---|
bool |
Methods
| Edit this page View SourceAwake()
Declaration
protected virtual void Awake()
OnDestroy()
Declaration
protected virtual void OnDestroy()
OnDisable()
Declaration
protected virtual void OnDisable()
OnEnable()
Declaration
protected virtual void OnEnable()
OnInspectRoutine()
Called to play the default item pickup animation and trigger the OnInspect UnityEvent. You can override this to provide your own custom animations
Declaration
protected abstract IEnumerator OnInspectRoutine()
Returns
Type | Description |
---|---|
IEnumerator |
Reset()
Declaration
protected virtual void Reset()
Events
| Edit this page View SourceOnKnightDamaged
Event triggered after the Knight takes damage.
Declaration
public event AfterTakeDamageHandler OnKnightDamaged
Event Type
Type | Description |
---|---|
AfterTakeDamageHandler |