Classes | Public Member Functions | Public Attributes | Protected Member Functions | Properties | Events | List of all members
PixelCrushers.DialogueSystem.Usable Class Reference

This component indicates that the game object is usable. More...

Inheritance diagram for PixelCrushers.DialogueSystem.Usable:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.Usable:
Collaboration graph
[legend]

Classes

class  UsableEvents
 

Public Member Functions

virtual void Start ()
 
virtual string GetName ()
 Gets the name of the override, including parsing if it contains a [lua] or [var] tag.
 
virtual void OnSelectUsable ()
 
virtual void OnDeselectUsable ()
 
virtual void OnUseUsable ()
 

Public Attributes

float maxUseDistance = 5f
 The max distance at which the object can be used.
 
UsableEvents events
 

Protected Member Functions

virtual void OnDisable ()
 

Properties

virtual string overrideName [get, set]
 
virtual string overrideUseMessage [get, set]
 

Events

UsableDelegate disabled = delegate { }
 

Detailed Description

This component indicates that the game object is usable.

This component works in conjunction with the Selector component. If you leave overrideName blank but there is an OverrideActorName component on the same object, this component will use the name specified in OverrideActorName.

Member Function Documentation

◆ GetName()

virtual string PixelCrushers.DialogueSystem.Usable.GetName ( )
inlinevirtual

Gets the name of the override, including parsing if it contains a [lua] or [var] tag.

Returns
The override name.

◆ OnDeselectUsable()

virtual void PixelCrushers.DialogueSystem.Usable.OnDeselectUsable ( )
inlinevirtual

◆ OnDisable()

virtual void PixelCrushers.DialogueSystem.Usable.OnDisable ( )
inlineprotectedvirtual

◆ OnSelectUsable()

virtual void PixelCrushers.DialogueSystem.Usable.OnSelectUsable ( )
inlinevirtual

◆ OnUseUsable()

virtual void PixelCrushers.DialogueSystem.Usable.OnUseUsable ( )
inlinevirtual

◆ Start()

virtual void PixelCrushers.DialogueSystem.Usable.Start ( )
inlinevirtual

Member Data Documentation

◆ events

UsableEvents PixelCrushers.DialogueSystem.Usable.events

◆ maxUseDistance

float PixelCrushers.DialogueSystem.Usable.maxUseDistance = 5f

The max distance at which the object can be used.

Property Documentation

◆ overrideName

virtual string PixelCrushers.DialogueSystem.Usable.overrideName
getset

◆ overrideUseMessage

virtual string PixelCrushers.DialogueSystem.Usable.overrideUseMessage
getset

Event Documentation

◆ disabled

UsableDelegate PixelCrushers.DialogueSystem.Usable.disabled = delegate { }
The documentation for this class was generated from the following file: