PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget Class Reference

Sends a message to a GameObject when TPC interacts with this component. More...

Inheritance diagram for PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget:
Collaboration diagram for PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget:

Public Member Functions

virtual void Awake ()
 
int GetInteractableID ()
 Returns the ID of the interactable target. More...
 
virtual bool IsInteractionReady ()
 Is the target ready to be interacted with? More...
 
virtual void Interact ()
 Interact with the target by sending the specified message (e.g., "OnUse"). More...
 

Public Attributes

Transform player
 The player's transform. More...
 
Transform target
 The recipient of the message. More...
 
string message = "OnUse"
 The message to send to the target. More...
 
bool debug = false
 Set true to log debug info. More...
 

Detailed Description

Sends a message to a GameObject when TPC interacts with this component.

The typical use is to send "OnUse" to a GameObject with Dialogue System triggers that are set to "OnUse".

Member Function Documentation

◆ Awake()

virtual void PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.Awake ( )
virtual

◆ GetInteractableID()

int PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.GetInteractableID ( )

Returns the ID of the interactable target.

Returns
The ID of the interactable target.

◆ Interact()

virtual void PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.Interact ( )
virtual

Interact with the target by sending the specified message (e.g., "OnUse").

◆ IsInteractionReady()

virtual bool PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.IsInteractionReady ( )
virtual

Is the target ready to be interacted with?

Returns
True if the target is ready to be interacted with.

Member Data Documentation

◆ debug

bool PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.debug = false

Set true to log debug info.

◆ message

string PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.message = "OnUse"

The message to send to the target.

◆ player

Transform PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.player

The player's transform.

If unassigned, this component will find the first GameObject tagged "Player".

◆ target

Transform PixelCrushers.DialogueSystem.ThirdPersonControllerSupport.DialogueSystemInteractableTarget.target

The recipient of the message.


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