uzihead/encounter-system
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed a ton of xml comments and such

Browse Source
This commit is contained in:
Sebastian Bularca
2026-04-19 12:46:26 +02:00
parent 8ce041e2d8
commit d05641c979
25 changed files with 221 additions and 367 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Runtime/EncounterTable.cs
View File

@@ -3,22 +3,11 @@ using System.Collections.Generic;
using UnityEngine;
namespace Jovian.EncounterSystem {
/// <summary>
/// A ScriptableObject asset holding a named list of encounters. Encounters inside the list are
/// authored via <c>[SerializeReference]</c> so different <see cref="IEncounter"/> implementations
/// and <see cref="IEncounterKind"/> payloads can coexist.
/// </summary>
[CreateAssetMenu(fileName = "EncounterTable", menuName = "Jovian/Encounter System/Encounter Table", order = 1)]
public class EncounterTable : ScriptableObject {
/// <summary>Designer-facing table identifier (free-form).</summary>
public string id;
/// <summary>Ordered encounter list. Each element is a concrete <see cref="Encounter"/> whose
/// type-specific payload is carried by its <see cref="IEncounterKind"/> (set in the inspector
/// via the SubclassSelector dropdown on <see cref="Encounter.Kind"/>).</summary>
public List<Encounter> encounters;
/// <summary>Pick a uniformly random encounter, or <c>null</c> if the table is empty.</summary>
public IEncounter GetRandomEncounter() {
if(encounters == null || encounters.Count == 0) {
return null;
@@ -27,9 +16,6 @@ namespace Jovian.EncounterSystem {
return encounters[UnityEngine.Random.Range(0, encounters.Count)];
}
/// <summary>Pick a uniformly random encounter whose runtime type matches <paramref name="type"/>,
/// or <c>null</c> if none match.</summary>
/// <param name="type">The concrete <see cref="IEncounter"/> runtime type to filter on.</param>
public IEncounter GetRandomEncounter(Type type) {
if(encounters == null || encounters.Count == 0) {
return null;
@@ -43,10 +29,7 @@ namespace Jovian.EncounterSystem {
return null;
}
/// <summary>Pick a uniformly random encounter matching <paramref name="filter"/>, or <c>null</c>
/// if no element passes. Used by <see cref="QuestProgress.IsGated"/> integration to exclude
/// gated quest encounters from rolls.</summary>
/// <param name="filter">Predicate applied to each encounter before rolling.</param>
/// <summary>Random pick limited by a predicate. Used with <see cref="QuestProgress.IsGated"/> to exclude gated encounters.</summary>
public IEncounter GetRandomEncounter(Predicate<IEncounter> filter) {
if(encounters == null || encounters.Count == 0 || filter == null) {
return GetRandomEncounter();