PixelCrushers.DialogueSystem.BarkOnIdle Class Reference

The Bark On Idle component can be used to make an NPC bark on timed intervals. More...

Inheritance diagram for PixelCrushers.DialogueSystem.BarkOnIdle:

Collaboration diagram for PixelCrushers.DialogueSystem.BarkOnIdle:

Public Member Functions
virtual void	StartBarkLoop ()
	Starts the bark loop.
Public Member Functions inherited from PixelCrushers.DialogueSystem.BarkStarter
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
bool	barkOnStart = false
bool	barkOnEnable = false
float	minSeconds = 5f
	The minimum seconds between barks.
float	maxSeconds = 10f
	The maximum seconds between barks.
Transform	target
	The target to bark at.
Public Attributes inherited from PixelCrushers.DialogueSystem.BarkStarter
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
override void	Start ()
override void	OnEnable ()
virtual IEnumerator	BarkLoop ()
virtual void	TryIdleBark ()
Protected Member Functions inherited from PixelCrushers.DialogueSystem.BarkStarter
virtual void	Awake ()
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 ()

Properties
override bool	useOnce [get]
Properties inherited from PixelCrushers.DialogueSystem.BarkStarter
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]

Additional Inherited Members
Protected Attributes inherited from PixelCrushers.DialogueSystem.BarkStarter
BarkHistory	barkHistory
bool	tryingToBark = false
ConversationState	cachedState = null
IBarkUI	barkUI = null
BarkGroupMember	barkGroupMember = null

Detailed Description

The Bark On Idle component can be used to make an NPC bark on timed intervals.

Barks don't occur while a conversation is active.

Member Function Documentation

BarkLoop()

virtual IEnumerator PixelCrushers.DialogueSystem.BarkOnIdle.BarkLoop ( )

inlineprotectedvirtual

OnEnable()

override void PixelCrushers.DialogueSystem.BarkOnIdle.OnEnable ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.DialogueSystem.BarkStarter.

Start()

override void PixelCrushers.DialogueSystem.BarkOnIdle.Start ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.DialogueSystem.BarkStarter.

StartBarkLoop()

virtual void PixelCrushers.DialogueSystem.BarkOnIdle.StartBarkLoop ( )

inlinevirtual

Starts the bark loop.

Normally this is started in the Start() method. If you need to restart it for some reason, call this method.

TryIdleBark()

virtual void PixelCrushers.DialogueSystem.BarkOnIdle.TryIdleBark ( )

inlineprotectedvirtual

Member Data Documentation

barkOnEnable

bool PixelCrushers.DialogueSystem.BarkOnIdle.barkOnEnable = false

barkOnStart

bool PixelCrushers.DialogueSystem.BarkOnIdle.barkOnStart = false

maxSeconds

float PixelCrushers.DialogueSystem.BarkOnIdle.maxSeconds = 10f

The maximum seconds between barks.

minSeconds

float PixelCrushers.DialogueSystem.BarkOnIdle.minSeconds = 5f

The minimum seconds between barks.

target

Transform PixelCrushers.DialogueSystem.BarkOnIdle.target

The target to bark at.

Leave unassigned to just bark into the air.

Property Documentation

useOnce

override bool PixelCrushers.DialogueSystem.BarkOnIdle.useOnce

getprotected

---

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/BarkOnIdle.cs