TopDown Engine  v4.2
MoreMountains.TopDownEngine.ProximityManaged Class Reference

A class to add to any object in your scene to mark it as managed by a proximity manager. More...

Inheritance diagram for MoreMountains.TopDownEngine.ProximityManaged:
MoreMountains.TopDownEngine.TopDownMonoBehaviour MoreMountains.Tools.MMMonoBehaviour

Public Member Functions

virtual void DebugAddObject ()
 A debug method used to add this object to a proximity manager More...
 
virtual void ProximitySetActive (bool status)
 

Public Attributes

float EnableDistance = 35f
 the distance from the proximity center (the player) under which the object should be enabled More...
 
float DisableDistance = 45f
 the distance from the proximity center (the player) after which the object should be disabled More...
 
bool DisabledByManager
 whether or not this object was disabled by the ProximityManager More...
 
int LastChangeAt
 the frame count at which this object got disabled More...
 
ProximityManager DebugProximityManager
 a debug manager to add this object to, only used for debug More...
 
bool AddButton
 a debug button to add this object to the debug manager More...
 
virtual bool StateChangedThisFrame => LastChangeAt == Time.frameCount
 

Properties

virtual ProximityManager Manager [get, set]
 

Detailed Description

A class to add to any object in your scene to mark it as managed by a proximity manager.

Member Function Documentation

◆ DebugAddObject()

virtual void MoreMountains.TopDownEngine.ProximityManaged.DebugAddObject ( )
virtual

A debug method used to add this object to a proximity manager

◆ ProximitySetActive()

virtual void MoreMountains.TopDownEngine.ProximityManaged.ProximitySetActive ( bool  status)
virtual

Member Data Documentation

◆ AddButton

bool MoreMountains.TopDownEngine.ProximityManaged.AddButton

a debug button to add this object to the debug manager

◆ DebugProximityManager

ProximityManager MoreMountains.TopDownEngine.ProximityManaged.DebugProximityManager

a debug manager to add this object to, only used for debug

◆ DisabledByManager

bool MoreMountains.TopDownEngine.ProximityManaged.DisabledByManager

whether or not this object was disabled by the ProximityManager

◆ DisableDistance

float MoreMountains.TopDownEngine.ProximityManaged.DisableDistance = 45f

the distance from the proximity center (the player) after which the object should be disabled

◆ EnableDistance

float MoreMountains.TopDownEngine.ProximityManaged.EnableDistance = 35f

the distance from the proximity center (the player) under which the object should be enabled

◆ LastChangeAt

int MoreMountains.TopDownEngine.ProximityManaged.LastChangeAt

the frame count at which this object got disabled

◆ StateChangedThisFrame

virtual bool MoreMountains.TopDownEngine.ProximityManaged.StateChangedThisFrame => LastChangeAt == Time.frameCount

Property Documentation

◆ Manager

virtual ProximityManager MoreMountains.TopDownEngine.ProximityManaged.Manager
getset

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