Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone Class Reference

Add this class to an empty GameObject. More...

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

Public Types

enum  FollowTarget { Nothing , Actor , Conversant }
 

Public Member Functions

virtual void Awake ()
 
virtual void OnConversationStart (Transform actor)
 
virtual void OnConversationEnd (Transform actor)
 
virtual void DisallowMovement ()
 
virtual void UndoDisallowMovement ()
 

Public Attributes

bool playerIsActor = true
 
bool canMoveWhileTalking = false
 
bool alsoDisableMovementComponentWhileTalking = true
 
bool landOnGroundWhileTalking = true
 
bool corgiControlsCameraWhileTalking = false
 
bool disableInventoryWhileTalking = true
 
bool pauseWhileTalking = false
 
FollowTarget dialogueUIFollows = FollowTarget.Nothing
 
Vector3 followOffset = Vector3.zero
 
bool hidePromptOnlyDuringConversation = true
 
string numActivationsLeftVariable = string.Empty
 

Protected Member Functions

override bool CheckConditions (GameObject collider)
 
override void ActivateZone ()
 When the zone is activated we start the conversation.
 
virtual Transform GetConversant ()
 
IEnumerator EnableCorgiComponentsAfterOneFrame ()
 
virtual void SetCorgiComponents (bool value)
 
virtual IEnumerator FreezeWhenGrounded (CorgiController controller)
 
virtual IEnumerator DisableComponentAfterFrame (MonoBehaviour monoBehaviour)
 
virtual void Update ()
 
override void OnEnable ()
 
override void OnDisable ()
 
override void TriggerExit (GameObject collider)
 
virtual void OnRecordPersistentData ()
 
virtual void OnApplyPersistentData ()
 

Protected Attributes

ConversationTrigger _conversationTrigger
 
List< DialogueSystemTrigger > _dialogueSystemTriggers = null
 
GameObject _player = null
 
DialogueActor _dialogueActor = null
 
CameraController _cameraController = null
 
MoreMountains.InventoryEngine.InventoryInputManager _inventoryInputManager = null
 
Transform _followTarget = null
 
Transform _ui = null
 
bool _isInConversation = false
 
float _timeLastConversationEnd = -1
 
bool _prevSendNavEvents = false
 
bool _wasMovementAllowed
 

Properties

ConversationTrigger conversationTrigger [get]
 
List< DialogueSystemTrigger > dialogueSystemTriggers [get]
 
GameObject player [get]
 
DialogueActor dialogueActor [get]
 
CameraController cameraController [get]
 
MoreMountains.InventoryEngine.InventoryInputManager inventoryInputManager [get]
 

Detailed Description

Add this class to an empty GameObject.

It will automatically add a boxcollider2d, set it to "is trigger". Then customize the conversation zone through the inspector to run a Dialogue System conversation.

Member Enumeration Documentation

◆ FollowTarget

enum PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.FollowTarget
Enumerator
Nothing 
Actor 
Conversant 

Member Function Documentation

◆ ActivateZone()

override void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.ActivateZone ( )
inlineprotected

When the zone is activated we start the conversation.

◆ Awake()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.Awake ( )
inlinevirtual

◆ CheckConditions()

override bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.CheckConditions ( GameObject  collider)
inlineprotected

◆ DisableComponentAfterFrame()

virtual IEnumerator PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.DisableComponentAfterFrame ( MonoBehaviour  monoBehaviour)
inlineprotectedvirtual

◆ DisallowMovement()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.DisallowMovement ( )
inlinevirtual

◆ EnableCorgiComponentsAfterOneFrame()

IEnumerator PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.EnableCorgiComponentsAfterOneFrame ( )
inlineprotected

◆ FreezeWhenGrounded()

virtual IEnumerator PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.FreezeWhenGrounded ( CorgiController  controller)
inlineprotectedvirtual

◆ GetConversant()

virtual Transform PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.GetConversant ( )
inlineprotectedvirtual

◆ OnApplyPersistentData()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.OnApplyPersistentData ( )
inlineprotectedvirtual

◆ OnConversationEnd()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.OnConversationEnd ( Transform  actor)
inlinevirtual

◆ OnConversationStart()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.OnConversationStart ( Transform  actor)
inlinevirtual

◆ OnDisable()

override void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.OnDisable ( )
inlineprotected

◆ OnEnable()

override void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.OnEnable ( )
inlineprotected

◆ OnRecordPersistentData()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.OnRecordPersistentData ( )
inlineprotectedvirtual

◆ SetCorgiComponents()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.SetCorgiComponents ( bool  value)
inlineprotectedvirtual

◆ TriggerExit()

override void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.TriggerExit ( GameObject  collider)
inlineprotected

◆ UndoDisallowMovement()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.UndoDisallowMovement ( )
inlinevirtual

◆ Update()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.Update ( )
inlineprotectedvirtual

Member Data Documentation

◆ _cameraController

CameraController PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._cameraController = null
protected

◆ _conversationTrigger

ConversationTrigger PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._conversationTrigger
protected

◆ _dialogueActor

DialogueActor PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._dialogueActor = null
protected

◆ _dialogueSystemTriggers

List<DialogueSystemTrigger> PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._dialogueSystemTriggers = null
protected

◆ _followTarget

Transform PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._followTarget = null
protected

◆ _inventoryInputManager

MoreMountains.InventoryEngine.InventoryInputManager PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._inventoryInputManager = null
protected

◆ _isInConversation

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._isInConversation = false
protected

◆ _player

GameObject PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._player = null
protected

◆ _prevSendNavEvents

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._prevSendNavEvents = false
protected

◆ _timeLastConversationEnd

float PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._timeLastConversationEnd = -1
protected

◆ _ui

Transform PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._ui = null
protected

◆ _wasMovementAllowed

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone._wasMovementAllowed
protected

◆ alsoDisableMovementComponentWhileTalking

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.alsoDisableMovementComponentWhileTalking = true

◆ canMoveWhileTalking

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.canMoveWhileTalking = false

◆ corgiControlsCameraWhileTalking

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.corgiControlsCameraWhileTalking = false

◆ dialogueUIFollows

FollowTarget PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.dialogueUIFollows = FollowTarget.Nothing

◆ disableInventoryWhileTalking

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.disableInventoryWhileTalking = true

◆ followOffset

Vector3 PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.followOffset = Vector3.zero

◆ hidePromptOnlyDuringConversation

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.hidePromptOnlyDuringConversation = true

◆ landOnGroundWhileTalking

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.landOnGroundWhileTalking = true

◆ numActivationsLeftVariable

string PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.numActivationsLeftVariable = string.Empty

◆ pauseWhileTalking

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.pauseWhileTalking = false

◆ playerIsActor

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.playerIsActor = true

Property Documentation

◆ cameraController

CameraController PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.cameraController
getprotected

◆ conversationTrigger

ConversationTrigger PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.conversationTrigger
getprotected

◆ dialogueActor

DialogueActor PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.dialogueActor
getprotected

◆ dialogueSystemTriggers

List<DialogueSystemTrigger> PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.dialogueSystemTriggers
getprotected

◆ inventoryInputManager

MoreMountains.InventoryEngine.InventoryInputManager PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.inventoryInputManager
getprotected

◆ player

GameObject PixelCrushers.DialogueSystem.CorgiEngineSupport.ConversationZone.player
getprotected
The documentation for this class was generated from the following file: