Documents BattleImpl ctor params

This commit is contained in:
Deukhoofd 2024-12-27 15:10:15 +01:00
parent 78114afd80
commit b4e8ad1cd2
Signed by: Deukhoofd
GPG Key ID: F63E044490819F6F
1 changed files with 6 additions and 0 deletions

View File

@ -122,6 +122,12 @@ public interface IBattle : IScriptSource
public class BattleImpl : ScriptSource, IBattle public class BattleImpl : ScriptSource, IBattle
{ {
/// <inheritdoc cref="BattleImpl"/> /// <inheritdoc cref="BattleImpl"/>
/// <param name="library">The library the battle uses for data and dynamic handling.</param>
/// <param name="parties">The parties that will be in the battle.</param>
/// <param name="canFlee">Whether Pokémon are allowed to flee from the battle.</param>
/// <param name="numberOfSides">The number of sides in the battle. Generally 2.</param>
/// <param name="positionsPerSide">The number of spots there are on each side for Pokémon. 1 for singles, 2 for doubles, etc.</param>
/// <param name="randomSeed">The seed for the RNG. If null, this uses a time-dependent seed.</param>
public BattleImpl(IDynamicLibrary library, IReadOnlyList<IBattleParty> parties, bool canFlee, byte numberOfSides, public BattleImpl(IDynamicLibrary library, IReadOnlyList<IBattleParty> parties, bool canFlee, byte numberOfSides,
byte positionsPerSide, int? randomSeed = null) byte positionsPerSide, int? randomSeed = null)
{ {