Class TwoDimArrayFactory

Namespace

Anvil.Services

Assembly

NWN.Anvil.dll

Creates a deserialized 2da structure using a ITwoDimArray converter.

[ServiceBinding(typeof(TwoDimArrayFactory))]
[Obsolete("Create instances of Anvil.API.TwoDimArray instead.")]
public sealed class TwoDimArrayFactory

Inheritance

object

TwoDimArrayFactory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

CollectionExtensions.SafeYield<T>(T?)

CollectionExtensions.Yield<T>(T)

Examples

/*
 * Define a implementation to deserialize "xptable.2da", and use this class to determine how much XP is remaining until the next level.
 */

using System.Linq;
using Anvil.API;
using Anvil.API.Events;
using Anvil.Services;

namespace NWN.Anvil.Samples.Services
{
  // This is the deserialization class for this specific type of 2da.
  // We can implement our own helper functions here that operate on the 2da data, and cache it.
  public sealed class ExpTableEntry : ITwoDimArrayEntry
  {
    public int Level { get; private set; }

    public int XP { get; private set; }

    // RowIndex is already populated externally, and we do not need to assign it in InterpretEntry.
    public int RowIndex { get; init; }

    // InterpretEntry is where we populate our entry properties (Level & XP) with the correct data.
    public void InterpretEntry(TwoDimArrayEntry entry)
    {
      Level = entry.GetInt("Level").GetValueOrDefault(0);
      XP = entry.GetInt("XP").GetValueOrDefault(0);
    }
  }

  [ServiceBinding(typeof(XPReportService))]
  public class XPReportService
  {
    // The TwoDimArray is created here.
    // ExpTableEntry (the type above) is passed in as a type parameter to be used to create our row data from exptable.2da.
    private readonly TwoDimArray<ExpTableEntry> expTable = NwGameTables.GetTable<ExpTableEntry>("exptable.2da")!;

    public XPReportService()
    {
      NwModule.Instance.OnClientEnter += OnClientEnter;
    }

    private void OnClientEnter(ModuleEvents.OnClientEnter onClientEnter)
    {
      NwPlayer player = onClientEnter.Player;
      NwCreature? creature = player.ControlledCreature;
      if (creature == null)
      {
        return;
      }

      int nextLevel = GetLevelFromXp(creature.Xp) + 1;
      if (nextLevel > MaxLevel)
      {
        return;
      }

      player.SendServerMessage($"Next level up: {GetXpForLevel(nextLevel) - creature.Xp}");
    }

    /// <summary>
    /// Gets the max possible player level.
    /// </summary>
    public int MaxLevel => expTable[^1].Level;

    /// <summary>
    /// Gets the amount of XP needed for the specified level.
    /// </summary>
    /// <param name="level">The level to lookup.</param>
    public int GetXpForLevel(int level)
    {
      return expTable.First(entry => entry.Level == level).XP;
    }

    /// <summary>
    /// Gets the current level for a player with the specified XP.
    /// </summary>
    /// <param name="xp">The amount of xp.</param>
    public int GetLevelFromXp(int xp)
    {
      int level = 1;
      foreach (ExpTableEntry entry in expTable.Rows)
      {
        if (entry.XP > xp)
        {
          break;
        }

        level = entry.Level;
      }

      return level;
    }
  }
}

Constructors

TwoDimArrayFactory(InjectionService)

Creates a deserialized 2da structure using a ITwoDimArray converter.

Methods

Get2DA<T>(string, bool)

Deserializes the given 2da using the specified format.