Adventure Creator  1.75.4
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2019
AC.DetectHotspots Class Reference
Inheritance diagram for AC.DetectHotspots:

Public Member Functions

void _Update ()
 
Hotspot[] GetAllDetectedHotspots ()
 Gets all Hotspots found within the object's Trigger collider. More...
 
Hotspot GetSelected ()
 Gets the currently-active Hotspot. More...
 
void ForceRemoveHotspot (Hotspot _hotspot)
 Removes a Hotspot from the script's internal record of detected Hotspots. More...
 
bool IsHotspotInTrigger (Hotspot hotspot)
 Checks if a specific Hotspot is within its volume. More...
 
void HighlightAll ()
 

Protected Member Functions

void Start ()
 
void OnEnable ()
 
void OnDisable ()
 
void OnTriggerStay (Collider other)
 
void OnTriggerStay2D (Collider2D other)
 
void OnTriggerExit (Collider other)
 
void OnInitialiseScene ()
 
bool IsLayerCorrect (int layerInt, bool distantToo=false)
 
void OnTriggerExit2D (Collider2D other)
 
void CycleHotspots (bool goRight)
 
bool IsActivePlayer ()
 

Protected Attributes

Hotspot nearestHotspot
 
int selected = 0
 
List< Hotspothotspots = new List<Hotspot>()
 
int hotspotLayerInt
 
int distantHotspotLayerInt
 

Properties

Hotspot NearestHotspot [get]
 

Detailed Description

Used to only allow Hotspots within a given volume to be selectable. Attach this as a child object to your Player prefab, and assign it as your Hotspot detector child - be sure to set "hotspot detection" to Player Vicinity in SettingsManager.

Member Function Documentation

◆ _Update()

void AC.DetectHotspots._Update ( )

Detects Hotspots in its vicinity. This is public so that it can be called by StateHandler every frame.

◆ ForceRemoveHotspot()

void AC.DetectHotspots.ForceRemoveHotspot ( Hotspot  _hotspot)

Removes a Hotspot from the script's internal record of detected Hotspots.

Parameters
_hotspotThe Hotspot to forget

◆ GetAllDetectedHotspots()

Hotspot [] AC.DetectHotspots.GetAllDetectedHotspots ( )

Gets all Hotspots found within the object's Trigger collider.

Returns
All Hotspots found within the object's Trigger collider.

◆ GetSelected()

Hotspot AC.DetectHotspots.GetSelected ( )

Gets the currently-active Hotspot.

Returns
The currently active Hotspot.

◆ HighlightAll()

void AC.DetectHotspots.HighlightAll ( )

Highlights all Hotspots within its volume.

◆ IsHotspotInTrigger()

bool AC.DetectHotspots.IsHotspotInTrigger ( Hotspot  hotspot)

Checks if a specific Hotspot is within its volume.

Parameters
hotspotThe Hotspot to check for
Returns
True if the Hotspot is within the Collider volume

Property Documentation

◆ NearestHotspot

Hotspot AC.DetectHotspots.NearestHotspot
get

The Hotspot nearest to the centre of the detector