PixelCrushers.QuestMachine.EntityType Class Reference

Entity types are abstract definitions of entities. More...

Inheritance diagram for PixelCrushers.QuestMachine.EntityType:

Collaboration diagram for PixelCrushers.QuestMachine.EntityType:

Public Member Functions
string	GetDescriptor (int count)
	Returns a text descriptor for a specified number of this entity type.
Faction	GetFaction ()
	Looks up this entity type's faction.
List< UrgencyFunction >	GetUrgencyFunctions ()
	Returns a list of urgency functions, including those inherited from parents.
DriveValue	LookupDriveValue (Drive drive)
	Looks up a drive value, first in the entity; failing that, checks parents.
float	GetRewardMultiplier (RewardMultiplier category)
	Returns the reward multiplier value for a specific category for this entity type.

Properties
string	description [get, set]
	Description of this entity type.
bool	isUnique [get, set]
	True if there is only one entity of this type.
StringField	displayName [get, set]
	The display name of this entity type.
StringField	pluralDisplayName [get, set]
	The plural display name for multiples of this entity type.
Sprite	image [get, set]
	The entity type's image may be shown in UIs.
int	level [get, set]
	The entity type's level, used to determine quest difficulty and rewards.
Faction	faction [get, set]
	The faction that this entity type belongs to.
List< EntityType >	parents [get, set]
	The entity type's parent types.
List< UrgencyFunction >	urgencyFunctions [get, set]
	Functions that quest generators use to determine how urgently they must generate a quest about this entity.
List< Action >	actions [get, set]
	Actions that can be performed on this entity type.
AnimationCurve	minCountInAction [get, set]
	When planning an action, set lower bound to this many targets.
AnimationCurve	maxCountInAction [get, set]
	When planning an action, limit to this many targets.
List< DriveValue >	originalDriveValues [get, set]
	The entity type's original drive values (not current runtime values).
List< DriveValue >	driveValues [get, set]
	This entity type's drives.

Detailed Description

Entity types are abstract definitions of entities.

Every entity in the game world has an entity type that defines its attributes such as its faction with other entities and actions that can be performed on it. The quest generator needs to work with abstract entity types because actual instances of the entities may not exist in the world at the time a quest is being generated.

Member Function Documentation

GetDescriptor()

string PixelCrushers.QuestMachine.EntityType.GetDescriptor ( int  count )

inline

Returns a text descriptor for a specified number of this entity type.

Parameters

count

The number of entities.

GetFaction()

Faction PixelCrushers.QuestMachine.EntityType.GetFaction ( )

inline

Looks up this entity type's faction.

Returns

This entity type's faction, or its parent's faction if unassigned.

GetRewardMultiplier()

float PixelCrushers.QuestMachine.EntityType.GetRewardMultiplier ( RewardMultiplier  category )

inline

Returns the reward multiplier value for a specific category for this entity type.

Parameters

category

The reward multiplier category.

Returns

The multiplier value.

GetUrgencyFunctions()

List< UrgencyFunction > PixelCrushers.QuestMachine.EntityType.GetUrgencyFunctions ( )

inline

Returns a list of urgency functions, including those inherited from parents.

LookupDriveValue()

DriveValue PixelCrushers.QuestMachine.EntityType.LookupDriveValue ( Drive  drive )

inline

Looks up a drive value, first in the entity; failing that, checks parents.

Property Documentation

actions

List<Action> PixelCrushers.QuestMachine.EntityType.actions

getset

Actions that can be performed on this entity type.

description

string PixelCrushers.QuestMachine.EntityType.description

getset

Description of this entity type.

displayName

StringField PixelCrushers.QuestMachine.EntityType.displayName

getset

The display name of this entity type.

driveValues

List<DriveValue> PixelCrushers.QuestMachine.EntityType.driveValues

getset

This entity type's drives.

Used by quest generators to decide on targets and actions. Values may change at runtime.

faction

Faction PixelCrushers.QuestMachine.EntityType.faction

getset

The faction that this entity type belongs to.

image

Sprite PixelCrushers.QuestMachine.EntityType.image

getset

The entity type's image may be shown in UIs.

isUnique

bool PixelCrushers.QuestMachine.EntityType.isUnique

getset

True if there is only one entity of this type.

level

int PixelCrushers.QuestMachine.EntityType.level

getset

The entity type's level, used to determine quest difficulty and rewards.

maxCountInAction

AnimationCurve PixelCrushers.QuestMachine.EntityType.maxCountInAction

getset

When planning an action, limit to this many targets.

Key is total number known; value is max number to require in action.

minCountInAction

AnimationCurve PixelCrushers.QuestMachine.EntityType.minCountInAction

getset

When planning an action, set lower bound to this many targets.

Key is total number known; value is min number to require in action. Note: Actual count in action may be lower if target is still the most urgent but count is fewer than this value.

originalDriveValues

List<DriveValue> PixelCrushers.QuestMachine.EntityType.originalDriveValues

getset

The entity type's original drive values (not current runtime values).

parents

List<EntityType> PixelCrushers.QuestMachine.EntityType.parents

getset

The entity type's parent types.

pluralDisplayName

StringField PixelCrushers.QuestMachine.EntityType.pluralDisplayName

getset

The plural display name for multiples of this entity type.

urgencyFunctions

List<UrgencyFunction> PixelCrushers.QuestMachine.EntityType.urgencyFunctions

getset

Functions that quest generators use to determine how urgently they must generate a quest about this entity.

---

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/Data/EntityType/EntityType.cs