Modding API : Ichirper

Ichirper

(l'oiseau qui gazouille)


IChirperMessage

Nom de l'expéditeur

Code:

string senderName { get; }

Le contenu du message

Code:

string text { get; }

ID du citoyen transmetteur

Code:

uint senderID { get; }

IChirper

Une interface plus légère pour interagir avec Chirper
Thread: N'importe lequel - Permet d'obtenir l'ensemble des des interfaces gestionnaires

Code:

IManagers managers { get; }

Thread: Principal - Permet de régler la position du Chirper à l"écran d'interface utilisateur.

Code:

Vector2 builtinChirperPosition { get; set; }

Thread: Principal - Il élimine Chirpy

Code:

bool DestroyBuiltinChirper();

Thread: Principal - Montre ou cache temporairement le panneau Chirper

Code:

bool ShowBuiltinChirper(bool show);

Thread: Principal
Configure Chriper par défaut pour qu'il reste centré à l'écran ; appeler cette méthode pour dés/activer son comportement.

Code:

bool SetBuiltinChirperFree(bool free);

Thread: Principal
Permet de définir le point d'ancrage du panneau de Chirper, il élargira en considérant que le point d'ancrage ne bouge pas.
HautGauche permet d'élargir vers le bas à droite.BasDroite vers le Haut Centre et ainsi de suite ...

Code:

bool SetBuiltinChirperAnchor(ChirperAnchor anchor);

Thread: Principal
Permet à Chirper to synchroniser the messages et déclenchera OnMessagesUpdated()

Code:

void SyncMessages();

Thread: Principal - Supprime les messages de Chirpy

Code:

void DeleteMessage(IChirperMessage message);

IIChirperExtension
Interface pure pour modifier le comportement de Chirper

Thread: Principal - Invoqué pour initialiser l'extension

Code:

void OnCreated(IChirper chirper);

Thread: Principal - Invoqué pour réinitialiser l'extension

Code:

void OnReleased();

Thread: Principal - Appelé une fois par frame

Code:

void OnUpdate();

Thread: Principal - Appelé quand Chirpy synchronise les messages (après le chargement d'une sauvegarde)

Code:

void OnMessagesUpdated();

Thread: Principal - invoqué quand Chirpy reçoit un nouveau message

Code:

void OnNewMessage(IChirperMessage message);

ChirperExtensionBase
Classe de base pour dériver à partir d'une modification de comportement de Chirper

Thread: N'importe lequel - Permet d'obtenir les interfaces manager globaux

Code:

IManagers managers { get; }

Thread: N'importe lequel - Permet d'obtenir l'interface gestionnaire de Chirpy

Code:

IChirper chirper { get; set; }

Thread: Principal - invoqué pour initialiser l'extension

Code:

void OnCreated(IChirper c);

Thread: Principal - invoqué pour réinitialiser l'extension

Code:

void OnReleased();

Thread: Principal - invoqué quand Chirper synchronise les messages

Code:

void OnMessagesUpdated();

Thread: Principal - invoqué une fois apr frame

Code:

void OnUpdate();

Thread: Principal - invoqué quand Chirper reçoit un nouveau message

Code:

void OnNewMessage(IChirperMessage message);

Code:

ChirperAnchor

Points d'ancrage supportés

Code:

enum ChirperAnchor
 {
   TopLeft,
   TopCenter,
   TopRight,
   BottomLeft,
   BottomCenter,
   BottomRight,
 }