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:

Public Member Functions

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

Public Attributes

string overrideName
 (Optional) Overrides the name shown by the Selector. More...
 
string overrideUseMessage
 (Optional) Overrides the use message shown by the Selector. More...
 
float maxUseDistance = 5f
 The max distance at which the object can be used. More...
 

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()

string PixelCrushers.DialogueSystem.Usable.GetName ( )

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

Returns
The override name.

◆ Start()

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

Member Data Documentation

◆ 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.


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