Modding API : Iareas

Iareas

Gestion des tuiles (zones)

Thread: N'importe lequel

Permet d'obtenir les interfaces (Cf. IManagers plus bas)

Code:

IManagers managers { get; }

Tuile de départ X index

Code:

int startTileX { get; }

Tuile de départ Z index

Code:

int startTileZ { get; }

Nombre de tuiles débloquées

Code:

int unlockedAreaCount { get; }

Nombre maxi de tuiles à débloquer (entre 1 et 25)

Code:

int maxAreaCount { get; set; }

Vérifie si les tuiles dans l'index sont débloquées

Code:

bool IsAreaUnlocked(int x, int z);

Vérifie si les tuiles dans l'index peuvent être débloquées

Code:

bool CanUnlockArea(int x, int z);

Calcule le prix de la tuile dans l'index

Code:

int GetAreaPrice(int x, int z);

Débloque la tuile de l'index donné et précise le montant nécessaire pour le déblocage

Code:

void UnlockArea(int x, int z, bool requireMoney);

IAreasExtension
Interface pure pour modifier le comportement de déblocage de tuiles

Thread: Main (principal) - Invoqué quand l'extension initialise (Cf. IAreas)

Code:

void OnCreated(IAreas areas);

Thread: Main (principal) - Invoqué quand l'extension réinitialise

Code:

void OnReleased();

Thread: N'importe lequel - Invoqué quand le jeu vérifie si la tuile peut être débloquée
Renvoie "true" si elle peut sinon "false"

Code:

originalResult contient l'estimation par defaut
bool OnCanUnlockArea(int x, int z, bool originalResult);

Thread: N'importe lequel - Invoqué quand le jeu calcule le prix d'une tuile
Il prend en compte l'information sur les ressources et connections

Code:

originalResult contient l'estimation par defaut
int OnGetAreaPrice(uint ore, uint oil, uint forest, uint fertility, uint water, bool road, bool train, bool ship, bool plane, float landFlatness, int originalPrice);

Thread: Simulation - Invoqué quand le jeu débloque une tuile
Notifie quelle tuile va être débloquée

Code:

void OnUnlockArea(int x, int z);

AreasExtensionBase
Classe de base qui permet de modifier le comportement de déverrouillage des tuiles.

Thread: N'importe lequel - Permet d'obtenir les interfaces manager globaux (cf. IManagers)

Code:

IManagers managers { get; }

Thread: N'importe lequel - Obtient l'interface du gestionnaire de domaine (cf. IAreas)

Code:

IAreas areaManager { get; set; }

Thread: Principal - Invoqué quand l'extension s'initialise

Code:

void OnCreated(IAreas areas);

Thread: Principal - Invoqué quand l'extension réinitialise

Code:

void OnReleased();

Thread: N'importe lequel - Invoqué quand le jeu vérifie qu'une tuile peut être débloquée
Redevient true si possible sinon false

Code:

originalResult contient l'estimation par défaut du jeu
bool OnCanUnlockArea(int x, int z, bool originalResult);

Thread: N'importe lequel - Invoqué quand le jeu calcule le prix d'une tuile
Les paramètres fournissent des informations sur les ressources et les connexions sortantes pour permettre le calcul des coûts.

Code:

originalResult contient l'estimation par défaut du jeu
int OnGetAreaPrice(uint ore, uint oil, uint forest, uint fertility, uint water, bool road, bool train, bool ship, bool plane, float landFlatness, int originalPrice);

Thread: Simulation - Invoqué quand le jeu débloque une tuile
Notifie quelle tuile de l'index est sur le point d'être débloquée.