PixelCrushers.DialogueSystem.Usable Class Reference

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

Inheritance diagram for PixelCrushers.DialogueSystem.Usable:

Collaboration diagram for PixelCrushers.DialogueSystem.Usable:

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
string	overrideName
	(Optional) Overrides the name shown by the Selector.
string	overrideUseMessage
	(Optional) Overrides the use message shown by the Selector.
float	maxUseDistance = 5f
	The max distance at which the object can be used.
UsableEvents	events

Protected Member Functions
virtual void	OnDisable ()

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.

overrideName

string PixelCrushers.DialogueSystem.Usable.overrideName

(Optional) Overrides the name shown by the Selector.

overrideUseMessage

string PixelCrushers.DialogueSystem.Usable.overrideUseMessage

(Optional) Overrides the use message shown by the Selector.

Event Documentation

disabled

UsableDelegate PixelCrushers.DialogueSystem.Usable.disabled = delegate { }

---

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

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/Triggers/Interaction/Usable.cs