PixelCrushers.DialogueSystem.Wrappers.ProximitySelector Class Reference

This wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class. More...

Inheritance diagram for PixelCrushers.DialogueSystem.Wrappers.ProximitySelector:
Collaboration diagram for PixelCrushers.DialogueSystem.Wrappers.ProximitySelector:

Additional Inherited Members

- Public Member Functions inherited from PixelCrushers.DialogueSystem.ProximitySelector
virtual void Start ()
 
virtual void OnConversationStart (Transform actor)
 
virtual void OnConversationEnd (Transform actor)
 
virtual void UseCurrentSelection ()
 Calls OnUse on the current selection.
 
virtual void RemoveGameObjectFromDetectedList (GameObject other)
 
virtual void RemoveUsableFromDetectedList (Usable usable)
 
virtual void SetCurrentUsable (Usable usable)
 
virtual void OnGUI ()
 If useDefaultGUI is true and a usable object has been targeted, this method draws a selection message and targeting reticle.
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.ProximitySelector
bool useDefaultGUI = true
 If true, uses a default OnGUI to display a selection message and targeting reticle.
 
GUISkin guiSkin
 The GUI skin to use for the target's information (name and use message).
 
string guiStyleName = "label"
 The name of the GUI style in the skin.
 
TextAnchor alignment = TextAnchor.UpperCenter
 The text alignment.
 
Color color = Color.yellow
 The color of the information labels when the target is in range.
 
TextStyle textStyle = TextStyle.Shadow
 The text style for the text.
 
Color textStyleColor = Color.black
 The color of the text style's outline or shadow.
 
string defaultUseMessage = "(spacebar to interact)"
 The default use message.
 
KeyCode useKey = KeyCode.Space
 The key that sends an OnUse message.
 
string useButton = "Fire2"
 The button that sends an OnUse message.
 
bool enableTouch = false
 Tick to enable touch triggering.
 
ScaledRect touchArea = new ScaledRect(ScaledRect.empty)
 If touch triggering is enabled and there's a touch in this area, the selector triggers.
 
bool broadcastToChildren = true
 If ticked, the OnUse message is broadcast to the usable object's children.
 
Transform actorTransform = null
 The actor transform to send with OnUse.
 
UsableUnityEvent onSelectedUsable = new UsableUnityEvent()
 
UsableUnityEvent onDeselectedUsable = new UsableUnityEvent()
 
List< UsableusablesInRange = new List<Usable>()
 Keeps track of which usable objects' triggers the selector is currently inside.
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.ProximitySelector
virtual void Reset ()
 
virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual void Update ()
 Sends an OnUse message to the current selection if the player presses the use button.
 
void OnSelectedUsableObject (Usable usable)
 
void OnDeselectedUsableObject (Usable usable)
 
virtual bool IsUseButtonDown ()
 Checks whether the player has just pressed the use button.
 
bool IsTouchDown ()
 
void OnTriggerEnter (Collider other)
 If we entered a trigger, check if it's a usable object.
 
void OnTriggerExit (Collider other)
 If we just left a trigger, check if it's the current selection.
 
void OnTriggerEnter2D (Collider2D other)
 If we entered a 2D trigger, check if it's a usable object.
 
void OnTriggerExit2D (Collider2D other)
 If we just left a 2D trigger, check if it's the current selection.
 
virtual void CheckTriggerEnter (GameObject other)
 
virtual void CheckTriggerExit (GameObject other)
 
virtual void OnUsableDisabled (Usable usable)
 
void SetGuiStyle ()
 
- Protected Attributes inherited from PixelCrushers.DialogueSystem.ProximitySelector
Usable currentUsable = null
 The current usable that will receive an OnUse message if the player hits the use button.
 
string currentHeading = string.Empty
 
string currentUseMessage = string.Empty
 
bool toldListenersHaveUsable = false
 
GUIStyle guiStyle = null
 Caches the GUI style to use when displaying the selection message in OnGUI.
 
float guiStyleLineHeight = 16f
 
float timeToEnableUseButton = 0
 
- Static Protected Attributes inherited from PixelCrushers.DialogueSystem.ProximitySelector
const float MinTimeBetweenUseButton = 0.5f
 
- Properties inherited from PixelCrushers.DialogueSystem.ProximitySelector
Usable CurrentUsable [get, set]
 Gets the current usable.
 
GUIStyle GuiStyle [get]
 Gets the GUI style.
 
- Events inherited from PixelCrushers.DialogueSystem.ProximitySelector
SelectedUsableObjectDelegate SelectedUsableObject = null
 Occurs when the selector has targeted a usable object.
 
DeselectedUsableObjectDelegate DeselectedUsableObject = null
 Occurs when the selector has untargeted a usable object.
 
System.Action Enabled = null
 
System.Action Disabled = null
 

Detailed Description

This wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class.


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