Inheritance diagram for AC.RuntimeObjectives:

Public Member Functions
void	OnInitPersistentEngine ()
void	SetObjectiveState (int objectiveID, int newStateID, bool selectAfter=false)
	Updates the state of an Objective.
void	SetObjectiveState (int objectiveID, ObjectiveStateType newStateType, bool selectAfter=false)
	Updates the state of an Objective.
void	SetObjectiveState (int objectiveID, int newStateID, int playerID)
	Updates the state of an Objective.
ObjectiveState	GetObjectiveState (int objectiveID)
	Gets the state of an active Objective.
ObjectiveState	GetObjectiveState (int objectiveID, int playerID)
	Gets the state of an active Objective, held by a specific Player.
void	CancelObjective (int objectiveID)
	Marks an Objective as inactive.
ObjectiveInstance	GetObjective (int objectiveID)
	Gets an instance of an active Objective.
ObjectiveInstance[]	GetObjectives (List< int > categoryIDs=null)
	Gets all active Objective instances.
ObjectiveInstance[]	GetObjectives (ObjectiveStateType objectiveStateType, List< int > categoryIDs=null)
	Gets all active Objective instances currently set to a particular type of state.
ObjectiveInstance[]	GetObjectives (ObjectiveDisplayType objectiveDisplayType, List< int > categoryIDs=null)
	Gets all active Objective instances currently set to a particular display type of state.
ObjectiveInstance[]	GetSubObjectives (int objectiveID)
	Gets all Objective instances in the category marked as the 'sub-objective category' for an Objective's current state.
ObjectiveInstance[]	GetSubObjectives (int objectiveID, ObjectiveStateType objectiveStateType)
	Gets all Objective instances in the category marked as the 'sub-objective category' for an Objective's current state.
void	SelectObjective (int objectiveID)
	Selects an Objective, so that it can be displayed in a Menu.
void	DeselectObjective ()
void	ClearAll ()
void	ClearUniqueToPlayer ()
PlayerData	SavePlayerObjectives (PlayerData playerData)
	Updates a PlayerData class with Objectives that are unique to the current Player.
void	AssignPlayerObjectives (PlayerData playerData)
	Restores saved data from a PlayerData class.
MainData	SaveGlobalObjectives (MainData mainData)
	Updates a MainData class with Objectives that are shared by all Players.
void	AssignGlobalObjectives (MainData mainData)
	Restores saved data from a MainData class.

Protected Attributes
List< ObjectiveInstance >	playerObjectiveInstances = new List<ObjectiveInstance>()
List< ObjectiveInstance >	globalObjectiveInstances = new List<ObjectiveInstance>()
ObjectiveInstance	selectedObjectiveInstance

Properties
ObjectiveInstance	SelectedObjective `[get, set]`

Detailed Description

This script keeps track of all active Objectives.

Member Function Documentation

◆ AssignGlobalObjectives()

void AC.RuntimeObjectives.AssignGlobalObjectives ( MainData mainData )

Restores saved data from a MainData class.

Parameters

playerData The MainData class to load from

◆ AssignPlayerObjectives()

void AC.RuntimeObjectives.AssignPlayerObjectives ( PlayerData playerData )

Restores saved data from a PlayerData class.

Parameters

playerData The PlayerData class to load from

◆ CancelObjective()

void AC.RuntimeObjectives.CancelObjective ( int objectiveID )

Marks an Objective as inactive.

Parameters

objectiveID The ID of the Objective

◆ ClearAll()

void AC.RuntimeObjectives.ClearAll ( )

Clears all Objective data

◆ ClearUniqueToPlayer()

void AC.RuntimeObjectives.ClearUniqueToPlayer ( )

Clears all Objective data that's per-player, and not global

◆ DeselectObjective()

void AC.RuntimeObjectives.DeselectObjective ( )

De-selects the selected Objective

◆ GetObjective()

ObjectiveInstance AC.RuntimeObjectives.GetObjective ( int objectiveID )

Gets an instance of an active Objective.

Parameters

objectiveID The ID of the Objective to search for

Returns: The ObjectiveInstance if active, or null if not

◆ GetObjectives() [1/3]

ObjectiveInstance[] AC.RuntimeObjectives.GetObjectives ( List< int > categoryIDs = null )

Gets all active Objective instances.

Parameters

categoryIDs If non-null, a list of category IDs that must include the Objective's own category ID for it to be returned

Returns: All active Objective instances

◆ GetObjectives() [2/3]

ObjectiveInstance[] AC.RuntimeObjectives.GetObjectives	(	ObjectiveDisplayType	objectiveDisplayType,
		List< int >	categoryIDs = null )

Gets all active Objective instances currently set to a particular display type of state.

Parameters

objectiveDisplayType	The type of display state to search for
categoryIDs	If non-null, a list of category IDs that must include the Objective's own category ID for it to be returned

Returns: All active Objective instances set to the type of display state

◆ GetObjectives() [3/3]

ObjectiveInstance[] AC.RuntimeObjectives.GetObjectives	(	ObjectiveStateType	objectiveStateType,
		List< int >	categoryIDs = null )

Gets all active Objective instances currently set to a particular type of state.

Parameters

objectiveStateType	The type of state to search for
categoryIDs	If non-null, a list of category IDs that must include the Objective's own category ID for it to be returned

Returns: All active Objective instances set to the type of state

◆ GetObjectiveState() [1/2]

ObjectiveState AC.RuntimeObjectives.GetObjectiveState ( int objectiveID )

Gets the state of an active Objective.

Parameters

objectiveID The ID of the Objective

Returns: The Objective's state, if active. If inactive, null is returned

◆ GetObjectiveState() [2/2]

ObjectiveState AC.RuntimeObjectives.GetObjectiveState	(	int	objectiveID,
		int	playerID )

Gets the state of an active Objective, held by a specific Player.

Parameters

objectiveID	The ID of the Objective
playerID	The ID of the Player

Returns: The Objective's state, if active. If inactive, or no player data is found, null is returned

◆ GetSubObjectives() [1/2]

ObjectiveInstance[] AC.RuntimeObjectives.GetSubObjectives ( int objectiveID )

Gets all Objective instances in the category marked as the 'sub-objective category' for an Objective's current state.

Parameters

objectiveID The ID of the Objective

Returns: All Objective instances that match the given criteria

◆ GetSubObjectives() [2/2]

ObjectiveInstance[] AC.RuntimeObjectives.GetSubObjectives	(	int	objectiveID,
		ObjectiveStateType	objectiveStateType )

Gets all Objective instances in the category marked as the 'sub-objective category' for an Objective's current state.

Parameters

objectiveID	The ID of the Objective
objectiveStateType	A filter for returned sub-Objectives based on their own current state<param> Returns All Objective instances that match the given criteria

◆ SaveGlobalObjectives()

MainData AC.RuntimeObjectives.SaveGlobalObjectives ( MainData mainData )

Updates a MainData class with Objectives that are shared by all Players.

Parameters

mainData The original MainData class

Returns: The updated MainData class

◆ SavePlayerObjectives()

PlayerData AC.RuntimeObjectives.SavePlayerObjectives ( PlayerData playerData )

Updates a PlayerData class with Objectives that are unique to the current Player.

Parameters

playerData The original PlayerData class

Returns: The updated PlayerData class

◆ SelectObjective()

void AC.RuntimeObjectives.SelectObjective ( int objectiveID )

Selects an Objective, so that it can be displayed in a Menu.

Parameters

objectiveID The ID of the Objective to select

◆ SetObjectiveState() [1/3]

void AC.RuntimeObjectives.SetObjectiveState	(	int	objectiveID,
		int	newStateID,
		bool	selectAfter = false )

Updates the state of an Objective.

Parameters

objectiveID	The ID of the Objective to update
newStateID	The ID of the Objective's new state
selectAfter	If True, the Objective will be considered 'selected' upon being updated

◆ SetObjectiveState() [2/3]

void AC.RuntimeObjectives.SetObjectiveState	(	int	objectiveID,
		int	newStateID,
		int	playerID )

Updates the state of an Objective.

Parameters

objectiveID	The ID of the Objective to update
newStateID	The ID of the Objective's new state
playerID	The ID of the Player whose Objectives to update, if the Objective is set per-Player

◆ SetObjectiveState() [3/3]

void AC.RuntimeObjectives.SetObjectiveState	(	int	objectiveID,
		ObjectiveStateType	newStateType,
		bool	selectAfter = false )

Updates the state of an Objective.

Parameters

objectiveID	The ID of the Objective to update
newStateType	The ObjectiveStateType of the Objective's new state. If not states of this type are found, no change will be made. If multiple states of this type are found, the first will be set.
selectAfter	If True, the Objective will be considered 'selected' upon being updated

Property Documentation

◆ SelectedObjective

ObjectiveInstance AC.RuntimeObjectives.SelectedObjective

getset

The instance of the currently-selected Objective

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ AssignGlobalObjectives()

◆ AssignPlayerObjectives()

◆ CancelObjective()

◆ ClearAll()

◆ ClearUniqueToPlayer()

◆ DeselectObjective()

◆ GetObjective()

◆ GetObjectives() [1/3]

◆ GetObjectives() [2/3]

◆ GetObjectives() [3/3]

◆ GetObjectiveState() [1/2]

◆ GetObjectiveState() [2/2]

◆ GetSubObjectives() [1/2]

◆ GetSubObjectives() [2/2]

◆ SaveGlobalObjectives()

◆ SavePlayerObjectives()

◆ SelectObjective()

◆ SetObjectiveState() [1/3]

◆ SetObjectiveState() [2/3]

◆ SetObjectiveState() [3/3]

Property Documentation

◆ SelectedObjective