Opsive.UltimateCharacterController.Character.Abilities.Converse Class Reference

The Converse ability runs when a character is the primary actor or conversant in an active conversation. More...

Inheritance diagram for Opsive.UltimateCharacterController.Character.Abilities.Converse:
Collaboration diagram for Opsive.UltimateCharacterController.Character.Abilities.Converse:

Classes

class  ConversingStateNames
 

Public Member Functions

override void Awake ()
 Add a Dialogue System Events component that listens for OnConversationStart and OnConversationEnd events to start and stop this ability.
 

Protected Member Functions

override void AbilityStarted ()
 
override void AbilityStopped (bool force)
 
Opsive.UltimateCharacterController.Camera.CameraController GetCameraController (ILookSource lookSource)
 
IEnumerator EnableInputAfterOneFrame ()
 
virtual string GetConversingStateName ()
 

Protected Attributes

bool m_HideUI = true
 
bool m_DisableGameplayInput = true
 
bool m_DetachCamera = true
 
ConversingStateNames m_ConversingStateNames = new ConversingStateNames()
 
GameObject m_OriginalCameraCharacter
 

Detailed Description

The Converse ability runs when a character is the primary actor or conversant in an active conversation.

Member Function Documentation

◆ AbilityStarted()

override void Opsive.UltimateCharacterController.Character.Abilities.Converse.AbilityStarted ( )
inlineprotected

◆ AbilityStopped()

override void Opsive.UltimateCharacterController.Character.Abilities.Converse.AbilityStopped ( bool  force)
inlineprotected

◆ Awake()

override void Opsive.UltimateCharacterController.Character.Abilities.Converse.Awake ( )
inline

Add a Dialogue System Events component that listens for OnConversationStart and OnConversationEnd events to start and stop this ability.

◆ EnableInputAfterOneFrame()

IEnumerator Opsive.UltimateCharacterController.Character.Abilities.Converse.EnableInputAfterOneFrame ( )
inlineprotected

◆ GetCameraController()

Opsive.UltimateCharacterController.Camera.CameraController Opsive.UltimateCharacterController.Character.Abilities.Converse.GetCameraController ( ILookSource  lookSource)
inlineprotected

◆ GetConversingStateName()

virtual string Opsive.UltimateCharacterController.Character.Abilities.Converse.GetConversingStateName ( )
inlineprotectedvirtual

Member Data Documentation

◆ m_ConversingStateNames

ConversingStateNames Opsive.UltimateCharacterController.Character.Abilities.Converse.m_ConversingStateNames = new ConversingStateNames()
protected

◆ m_DetachCamera

bool Opsive.UltimateCharacterController.Character.Abilities.Converse.m_DetachCamera = true
protected

◆ m_DisableGameplayInput

bool Opsive.UltimateCharacterController.Character.Abilities.Converse.m_DisableGameplayInput = true
protected

◆ m_HideUI

bool Opsive.UltimateCharacterController.Character.Abilities.Converse.m_HideUI = true
protected

◆ m_OriginalCameraCharacter

GameObject Opsive.UltimateCharacterController.Character.Abilities.Converse.m_OriginalCameraCharacter
protected

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