This is the base class for bark trigger components such as BarkOnIdle and BarkTrigger. More...

Inheritance diagram for PixelCrushers.DialogueSystem.BarkStarter:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.BarkStarter:

[legend]

Public Member Functions
void	TryBark (Transform target)
	Barks if the condition is true.

virtual void	TryBark (Transform target, Transform interactor)
	Barks if the condition is true.

void	ResetBarkHistory ()
	Resets the bark history to the beginning of the list of bark lines.

void	OnRecordPersistentData ()
	Listens for the OnRecordPersistentData message and records the current bark index.

void	OnApplyPersistentData ()
	Listens for the OnApplyPersistentData message and retrieves the current bark index.

Public Member Functions inherited from PixelCrushers.DialogueSystem.ConversationStarter
void	TryStartConversation (Transform actor)
	If the condition is true, starts the conversation between the specified actor and the character that this component is attached to.

void	TryStartConversation (Transform actor, Transform interactor)
	If the condition is true, starts the conversation between the specified actor and the character that this component is attached to.

Public Attributes
BarkOrder	barkOrder = BarkOrder.Random
	Specifies the order to run through the list of barks.

bool	allowDuringConversations = false
	Are barks allowed during conversations?

bool	cacheBarkLines = false
	If ticked, bark info is cached during the first bark.

Public Attributes inherited from PixelCrushers.DialogueSystem.ConversationStarter
string	conversation
	The title of the conversation to start.

Condition	condition
	The condition required for the conversation to start.

bool	skipIfNoValidEntries
	If this is `true<c/c> and no valid entries currently link from the start entry, don't start the conversation.`

bool	exclusive = false
	Only start if no other conversation is active.

Transform	conversant
	The conversant of the conversation.

bool	useConversationTitlePicker = true

DialogueDatabase	selectedDatabase = null

Public Attributes inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
bool	once = false
	Set `true` if this event should only happen once.

Protected Member Functions
virtual void	Awake ()

virtual void	Start ()

virtual void	OnEnable ()

virtual void	OnDisable ()

Transform	GetBarker ()

string	GetBarkerName ()

void	BarkCachedLine (Transform speaker, Transform listener)

void	PopulateCache (Transform speaker, Transform listener)

void	BarkNextCachedLine (Transform speaker, Transform listener)

Protected Member Functions inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
void	DestroyIfOnce ()

Protected Attributes
BarkHistory	barkHistory

bool	tryingToBark = false

ConversationState	cachedState = null

IBarkUI	barkUI = null

BarkGroupMember	barkGroupMember = null

Properties
Sequencer	sequencer `[get, protected set]`
	Gets the sequencer used by the current bark, if a bark is playing.

int	BarkIndex `[get, set]`
	Gets or sets the bark index for sequential barks.

Properties inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
virtual bool	useOnce `[get]`

Detailed Description

This is the base class for bark trigger components such as BarkOnIdle and BarkTrigger.

Member Function Documentation

◆ Awake()

virtual void PixelCrushers.DialogueSystem.BarkStarter.Awake ( )

inlineprotectedvirtual

◆ BarkCachedLine()

void PixelCrushers.DialogueSystem.BarkStarter.BarkCachedLine	(	Transform	speaker,
		Transform	listener
	)

inlineprotected

◆ BarkNextCachedLine()

void PixelCrushers.DialogueSystem.BarkStarter.BarkNextCachedLine	(	Transform	speaker,
		Transform	listener
	)

inlineprotected

◆ GetBarker()

Transform PixelCrushers.DialogueSystem.BarkStarter.GetBarker ( )

inlineprotected

◆ GetBarkerName()

string PixelCrushers.DialogueSystem.BarkStarter.GetBarkerName ( )

inlineprotected

◆ OnApplyPersistentData()

void PixelCrushers.DialogueSystem.BarkStarter.OnApplyPersistentData ( )

inline

Listens for the OnApplyPersistentData message and retrieves the current bark index.

◆ OnDisable()

virtual void PixelCrushers.DialogueSystem.BarkStarter.OnDisable ( )

inlineprotectedvirtual

Reimplemented in PixelCrushers.DialogueSystem.BarkTrigger.

◆ OnEnable()

virtual void PixelCrushers.DialogueSystem.BarkStarter.OnEnable ( )

inlineprotectedvirtual

Reimplemented in PixelCrushers.DialogueSystem.BarkOnIdle, and PixelCrushers.DialogueSystem.BarkTrigger.

◆ OnRecordPersistentData()

void PixelCrushers.DialogueSystem.BarkStarter.OnRecordPersistentData ( )

inline

Listens for the OnRecordPersistentData message and records the current bark index.

◆ PopulateCache()

void PixelCrushers.DialogueSystem.BarkStarter.PopulateCache	(	Transform	speaker,
		Transform	listener
	)

inlineprotected

◆ ResetBarkHistory()

void PixelCrushers.DialogueSystem.BarkStarter.ResetBarkHistory ( )

inline

Resets the bark history to the beginning of the list of bark lines.

◆ Start()

virtual void PixelCrushers.DialogueSystem.BarkStarter.Start ( )

inlineprotectedvirtual

Reimplemented in PixelCrushers.DialogueSystem.BarkOnIdle, and PixelCrushers.DialogueSystem.BarkTrigger.

◆ TryBark() [1/2]

void PixelCrushers.DialogueSystem.BarkStarter.TryBark ( Transform target )

inline

Barks if the condition is true.

Parameters

target Target.

◆ TryBark() [2/2]

virtual void PixelCrushers.DialogueSystem.BarkStarter.TryBark	(	Transform	target,
		Transform	interactor
	)

inlinevirtual

Barks if the condition is true.

Parameters

target	Target.
interactor	Interactor to test the condition against.

Reimplemented in PixelCrushers.DialogueSystem.InkSupport.BarkInkOnIdle.

Member Data Documentation

◆ allowDuringConversations

bool PixelCrushers.DialogueSystem.BarkStarter.allowDuringConversations = false

Are barks allowed during conversations?

◆ barkGroupMember

BarkGroupMember PixelCrushers.DialogueSystem.BarkStarter.barkGroupMember = null

protected

◆ barkHistory

BarkHistory PixelCrushers.DialogueSystem.BarkStarter.barkHistory

protected

◆ barkOrder

BarkOrder PixelCrushers.DialogueSystem.BarkStarter.barkOrder = BarkOrder.Random

Specifies the order to run through the list of barks.

Random: Choose a random bark from the conversation, avoiding sequential repeats if possible.
Sequential: Choose the barks in order from first to last, looping at the end.

◆ barkUI

IBarkUI PixelCrushers.DialogueSystem.BarkStarter.barkUI = null

protected

◆ cacheBarkLines

bool PixelCrushers.DialogueSystem.BarkStarter.cacheBarkLines = false

If ticked, bark info is cached during the first bark.

This can reduce stutter when barking on slower mobile devices, but barks are not reevaluated each time as the state changes, barks use no em formatting codes, and sequences are not played with barks.

◆ cachedState

ConversationState PixelCrushers.DialogueSystem.BarkStarter.cachedState = null

protected

◆ tryingToBark

bool PixelCrushers.DialogueSystem.BarkStarter.tryingToBark = false

protected

Property Documentation

◆ BarkIndex

int PixelCrushers.DialogueSystem.BarkStarter.BarkIndex

getset

Gets or sets the bark index for sequential barks.

The index of the bark, starting from 0.

◆ sequencer

Sequencer PixelCrushers.DialogueSystem.BarkStarter.sequencer

getprotected set

Gets the sequencer used by the current bark, if a bark is playing.

If a bark is not playing, this is undefined. To check if a bark is playing, check the bark UI's IsPlaying property.

The sequencer.

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/Triggers/Legacy/BarkStarter.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ Awake()

◆ BarkCachedLine()

◆ BarkNextCachedLine()

◆ GetBarker()

◆ GetBarkerName()

◆ OnApplyPersistentData()

◆ OnDisable()

◆ OnEnable()

◆ OnRecordPersistentData()

◆ PopulateCache()

◆ ResetBarkHistory()

◆ Start()

◆ TryBark() [1/2]

◆ TryBark() [2/2]

Member Data Documentation

◆ allowDuringConversations

◆ barkGroupMember

◆ barkHistory

◆ barkOrder

◆ barkUI

◆ cacheBarkLines

◆ cachedState

◆ tryingToBark

Property Documentation

◆ BarkIndex

◆ sequencer