A quest generator entity is an entity that can generate quests. More...

Inheritance diagram for PixelCrushers.QuestMachine.QuestGeneratorEntity:

[legend]

Collaboration diagram for PixelCrushers.QuestMachine.QuestGeneratorEntity:

[legend]

Public Member Functions
delegate void	UpdateWorldModelDelegate (WorldModel worldModel)

override void	Awake ()

virtual void	Start ()

override void	OnDestroy ()

void	RecordRewardSystems ()
	Updates the list of reward systems on this generator entity.

int	GetGeneratedQuestCount ()
	Returns the current number of generated quests.

virtual void	GenerateQuest ()
	Generates a quest if the current number of generated quests is under the max.

virtual WorldModel	BuildWorldModel ()
	Returns the world model as observed by this entity.

virtual WorldModel	BuildWorldModelFromDomains ()

virtual void	StartDialogueWithPlayer ()
	Starts dialogue with the first GameObject in the scene that's tagged as "Player".

virtual void	StartDialogue (GameObject player)
	Starts dialogue with the player.

virtual bool	IsMyQuestActive (QuestJournal questJournal)
	Checks if the quest journal has an active quest with this GameObject's quest giver ID.

Public Member Functions inherited from PixelCrushers.QuestMachine.QuestEntity
delegate void	EntityDelegate (QuestEntity entity)

virtual void	OnDisable ()

Protected Member Functions
IEnumerator	GenerateQuestOnStart ()

virtual List< Quest >	GetExistingQuests ()

virtual void	OnGeneratedQuest (Quest quest)

IEnumerator	GenerateQuestThenTalk (GameObject player)

Properties
StringField	questGroup `[get, set]`
	Organize quests in this group.

DomainType	domainType `[get, set]`
	The domain type where this quest giver is located.

bool	excludeEntitiesInQuestJournals `[get, set]`
	Don't generate quests about entities that are already in quests in Quest Journals.

bool	requireReturnToComplete `[get, set]`
	Require the quester to speak to the quest giver to finish the quest.

bool	generateAbandonableQuests `[get, set]`
	Allow generated quests to be abandoned.

QuestDomain[]	domains `[get, set]`
	The domains that this quest giver observes.

UrgentFactSelectionMode	goalSelectionMode `[get, set]`

BasicUIContent	rewardsUIContents `[get, set]`
	The UI content to show above the list of rewards offered for a quest.

List< RewardSystem >	rewardSystems `[get, set]`
	Reward systems to use to generate rewards.

bool	generateQuestOnStart `[get, set]`
	Generate a quest as soon as the component starts.

int	maxQuestsToGenerate `[get, set]`
	Generate a quest only if the quest list is smaller than this.

QuestListContainer	questListContainer `[get, set]`

QuestGenerator	questGenerator `[get]`

bool	isGenerating `[get, protected set]`
	Is this QuestGeneratorEntity currently generating a quest?

Properties inherited from PixelCrushers.QuestMachine.QuestEntity
EntityType	entityType `[get, set]`
	This entity's entity type.

bool	hasInternallyAssignedID `[get]`

bool	hasInternallyAssignedDisplayName `[get]`

StringField	id `[get]`
	Internal ID that Quest Machine can use to reference this GameObject.

StringField	displayName `[get]`
	Name to show in UIs.

Sprite	image `[get]`
	Image to show in UIs.

Properties inherited from PixelCrushers.QuestMachine.IQuestMachineID

Events
UpdateWorldModelDelegate	updateWorldModel = delegate { }

GeneratedQuestDelegate	generatedQuest = delegate { }

Events inherited from PixelCrushers.QuestMachine.QuestEntity
EntityDelegate	despawned = delegate { }

Detailed Description

A quest generator entity is an entity that can generate quests.

Member Function Documentation

◆ Awake()

override void PixelCrushers.QuestMachine.QuestGeneratorEntity.Awake ( )

inlinevirtual

Reimplemented from PixelCrushers.QuestMachine.QuestEntity.

◆ BuildWorldModel()

virtual WorldModel PixelCrushers.QuestMachine.QuestGeneratorEntity.BuildWorldModel ( )

inlinevirtual

Returns the world model as observed by this entity.

◆ BuildWorldModelFromDomains()

virtual WorldModel PixelCrushers.QuestMachine.QuestGeneratorEntity.BuildWorldModelFromDomains ( )

inlinevirtual

◆ GenerateQuest()

virtual void PixelCrushers.QuestMachine.QuestGeneratorEntity.GenerateQuest ( )

inlinevirtual

Generates a quest if the current number of generated quests is under the max.

◆ GenerateQuestOnStart()

IEnumerator PixelCrushers.QuestMachine.QuestGeneratorEntity.GenerateQuestOnStart ( )

inlineprotected

◆ GenerateQuestThenTalk()

IEnumerator PixelCrushers.QuestMachine.QuestGeneratorEntity.GenerateQuestThenTalk ( GameObject player )

inlineprotected

◆ GetExistingQuests()

virtual List< Quest > PixelCrushers.QuestMachine.QuestGeneratorEntity.GetExistingQuests ( )

inlineprotectedvirtual

◆ GetGeneratedQuestCount()

int PixelCrushers.QuestMachine.QuestGeneratorEntity.GetGeneratedQuestCount ( )

inline

Returns the current number of generated quests.

◆ IsMyQuestActive()

virtual bool PixelCrushers.QuestMachine.QuestGeneratorEntity.IsMyQuestActive ( QuestJournal questJournal )

inlinevirtual

Checks if the quest journal has an active quest with this GameObject's quest giver ID.

◆ OnDestroy()

override void PixelCrushers.QuestMachine.QuestGeneratorEntity.OnDestroy ( )

inlinevirtual

Reimplemented from PixelCrushers.QuestMachine.QuestEntity.

◆ OnGeneratedQuest()

virtual void PixelCrushers.QuestMachine.QuestGeneratorEntity.OnGeneratedQuest ( Quest quest )

inlineprotectedvirtual

◆ RecordRewardSystems()

void PixelCrushers.QuestMachine.QuestGeneratorEntity.RecordRewardSystems ( )

inline

Updates the list of reward systems on this generator entity.

◆ Start()

virtual void PixelCrushers.QuestMachine.QuestGeneratorEntity.Start ( )

inlinevirtual

Reimplemented in PixelCrushers.QuestMachine.InventoryProQuestGeneratorEntity, and PixelCrushers.QuestMachine.uSurvivalQuestGeneratorEntity.

◆ StartDialogue()

virtual void PixelCrushers.QuestMachine.QuestGeneratorEntity.StartDialogue ( GameObject player )

inlinevirtual

Starts dialogue with the player.

Works like QuestGiver.StartDialogue but generates a quest if necessary.

Parameters

player Player conversing with this QuestGiver. If null, searches the scene for a GameObject tagged Player.

◆ StartDialogueWithPlayer()

virtual void PixelCrushers.QuestMachine.QuestGeneratorEntity.StartDialogueWithPlayer ( )

inlinevirtual

Starts dialogue with the first GameObject in the scene that's tagged as "Player".

Generates a quest if necessary.

◆ UpdateWorldModelDelegate()

delegate void PixelCrushers.QuestMachine.QuestGeneratorEntity.UpdateWorldModelDelegate ( WorldModel worldModel )

Property Documentation

◆ domains

QuestDomain [] PixelCrushers.QuestMachine.QuestGeneratorEntity.domains

getset

The domains that this quest giver observes.

◆ domainType

DomainType PixelCrushers.QuestMachine.QuestGeneratorEntity.domainType

getset

The domain type where this quest giver is located.

◆ excludeEntitiesInQuestJournals

bool PixelCrushers.QuestMachine.QuestGeneratorEntity.excludeEntitiesInQuestJournals

getset

Don't generate quests about entities that are already in quests in Quest Journals.

◆ generateAbandonableQuests

bool PixelCrushers.QuestMachine.QuestGeneratorEntity.generateAbandonableQuests

getset

Allow generated quests to be abandoned.

◆ generateQuestOnStart

bool PixelCrushers.QuestMachine.QuestGeneratorEntity.generateQuestOnStart

getset

Generate a quest as soon as the component starts.

◆ goalSelectionMode

UrgentFactSelectionMode PixelCrushers.QuestMachine.QuestGeneratorEntity.goalSelectionMode

getset

◆ isGenerating

bool PixelCrushers.QuestMachine.QuestGeneratorEntity.isGenerating

getprotected set

Is this QuestGeneratorEntity currently generating a quest?

◆ maxQuestsToGenerate

int PixelCrushers.QuestMachine.QuestGeneratorEntity.maxQuestsToGenerate

getset

Generate a quest only if the quest list is smaller than this.

◆ questGenerator

QuestGenerator PixelCrushers.QuestMachine.QuestGeneratorEntity.questGenerator

get

◆ questGroup

StringField PixelCrushers.QuestMachine.QuestGeneratorEntity.questGroup

getset

Organize quests in this group.

Leave blank for no group.

◆ questListContainer

QuestListContainer PixelCrushers.QuestMachine.QuestGeneratorEntity.questListContainer

getset

◆ requireReturnToComplete

bool PixelCrushers.QuestMachine.QuestGeneratorEntity.requireReturnToComplete

getset

Require the quester to speak to the quest giver to finish the quest.

◆ rewardsUIContents

BasicUIContent PixelCrushers.QuestMachine.QuestGeneratorEntity.rewardsUIContents

getset

The UI content to show above the list of rewards offered for a quest.

◆ rewardSystems

List<RewardSystem> PixelCrushers.QuestMachine.QuestGeneratorEntity.rewardSystems

getset

Reward systems to use to generate rewards.

Event Documentation

◆ generatedQuest

GeneratedQuestDelegate PixelCrushers.QuestMachine.QuestGeneratorEntity.generatedQuest = delegate { }

◆ updateWorldModel

UpdateWorldModelDelegate PixelCrushers.QuestMachine.QuestGeneratorEntity.updateWorldModel = delegate { }

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

C:/Dev/Quest Machine/Dev/Source/Assets/Plugins/Pixel Crushers/Quest Machine/Scripts/Quest Generator/MonoBehaviours/QuestGeneratorEntity.cs

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ Awake()

◆ BuildWorldModel()

◆ BuildWorldModelFromDomains()

◆ GenerateQuest()

◆ GenerateQuestOnStart()

◆ GenerateQuestThenTalk()

◆ GetExistingQuests()

◆ GetGeneratedQuestCount()

◆ IsMyQuestActive()

◆ OnDestroy()

◆ OnGeneratedQuest()

◆ RecordRewardSystems()

◆ Start()

◆ StartDialogue()

◆ StartDialogueWithPlayer()

◆ UpdateWorldModelDelegate()

Property Documentation

◆ domains

◆ domainType

◆ excludeEntitiesInQuestJournals

◆ generateAbandonableQuests

◆ generateQuestOnStart

◆ goalSelectionMode

◆ isGenerating

◆ maxQuestsToGenerate

◆ questGenerator

◆ questGroup

◆ questListContainer

◆ requireReturnToComplete

◆ rewardsUIContents

◆ rewardSystems

Event Documentation

◆ generatedQuest

◆ updateWorldModel