JourneyCandidateFULL version only
Description
A possible target for the Journey System. A simple class to help collect journey candidates with the relevant data. Use the Dungeon CollectAllJourneyCandidates method to get a list of JourneyCandidates, then use the static methods in this class to find the candidates you are looking for.
Properties
Room | Room | ReadOnly Gets the Room where the JourneyCandidate is located. |
Types | BaseSpawnableType | ReadOnly Gets the Types associated to this JourneyCandidate. |
BaseSpawnable | BaseSpawnable | ReadOnly Gets the BaseSpawnable. |
IsCompleted | bool | ReadOnly True if this BaseSpawnable is a Spawnable located at a completed SpawnPoint; otherwise, false. |
IsConnector | bool | ReadOnly True if this BaseSpawnable is a Connector; otherwise, false. |
GetIncompleteSpawnables
public static List GetIncompleteSpawnables(List candidates);
Parameters
candidates | List |
A raw candidates list from which the desired candidates must be extracted. |
Return
candidates | The list of JourneyCandidate that consist of Spawnables located at a SpawnPoint that isn’t completed. |
Description
Get the incomplete Spawnables from a list of JourneyCandidates. Incomplete spawnables are usually spawnables that the character hasn’t collected/used yet.
GetCompletedSpawnables
public static List GetCompletedSpawnables(List candidates);
Parameters
candidates | List |
A raw candidates list from which the desired candidates must be extracted. |
Return
candidates | The list of JourneyCandidate that consist of Spawnables located at a SpawnPoint that is completed. |
Description
Get the completed Spawnables from a list of JourneyCandidates. Complete spawnables are usually spawnables that the character has already collected/used.
GetConnectors
public static List GetConnectors(List candidates);
Parameters
candidates | List |
A raw candidates list from which the desired candidates must be extracted. |
Return
candidates | The list of JourneyCandidate that consist of Connectors. |
Description
Get the Connectors from a list of JourneyCandidates.
GetTypesWithAllowJourney
public static List GetTypesWithAllowJourney(List candidates);
Parameters
candidates | List |
A raw candidates list from which the BaseSpawnableTypes must be extracted. |
Return
List<BaseSpawnableType> | The list of BaseSpawnableTypes that allow journeys. |
Description
Gets the types that allow journeys from a list of Journey Candidates.
GetCandidatesWithSpecifiedType
public static List GetCandidatesWithSpecifiedType(List candidates, BaseSpawnableType type);
Parameters
candidates | List |
A raw candidates list from which the desired candidates must be extracted. |
type | BaseSpawnableType | The type the candidates must be associated to. |
Return
candidates | The list of JourneyCandidate that are associated with the specified BaseSpawnableType. |
Description
Gets the list of JourneyCandidate that are associated with the specified BaseSpawnableType
GetKnownCandidates
public static List GetKnownCandidates(List candidates);
Parameters
candidates | List |
A raw candidates list from which the desired candidates must be extracted. |
Return
candidates | The list of JourneyCandidate that the character knows about, depending on the RoomStatus and its most visible BaseSpawnableType MapDisplayMode. |
Description
Get the list of JourneyCandidate that the character knows about, depending on the RoomStatus and its most visible BaseSpawnableType MapDisplayMode.