Contents Up Previous Next

Types d'énumérations intégrés

AGS possède plusieurs types d'énumération intégrés. Ceux-ci sont utilisés avec diverses commandes, et s'afficheront automatiquement en autocomplétion dans l'éditeur de scripts. Cependant, pour les moment où l'autocomplétion ne fonctionne pas, le manuel de référence s'avère assez utile :

enum BlockingStyle {
  eBlock,
  eNoBlock
};
Permet de bloquer l'exécution du script (eBlock) ou non (eNoBlock).

Utilisé par : Character.Animate, Character.FaceCharacter, Character.FaceLocation, Character.FaceObject, Character.Walk, Character.WalkStraight, Object.Animate, Object.Move

enum Direction {
  eForwards,
  eBackwards
};
Définit si une animation est jouée dans l'ordre normal (eForwards) ou à l'envers (eBackwards).

Utilisé par : Character.Animate, Object.Animate

enum WalkWhere {
  eAnywhere,
  eWalkableAreas
};
Indique si le déplacement doit se faire en respectant les zones de déplacement (eWalkableAreas) ou non (eAnyWhere).

Utilisé par : Character.Walk, Object.Move

enum RepeatStyle {
  eOnce,
  eRepeat
};
Utilisé par : Button.Animate, Character.Animate, Object.Animate

enum Alignment {
  eAlignLeft,
  eAlignCentre,
  eAlignRight
};
Définit la façon dont est aligné un texte (Left = Gauche, Centre = Milieu, Right = Droite).

Utilisé par : Character.LockViewAligned

enum eFlipDirection {
  eFlipLeftToRight,
  eFlipUpsideDown,
  eFlipBoth
};
Détermine la façon dont pivote l'image : LeftToRight = de gauche à droite, UpsideDown = de haut en bas, Both = les deux.

Utilisé par : DynamicSprite.Flip

enum TransitionStyle {
  eTransitionFade,
  eTransitionInstant,
  eTransitionDissolve,
  eTransitionBoxout,
  eTransitionCrossfade
};
Permet de spécifier la façon dont l'écran s'affiche/s'efface.

Utilisé par : SetScreenTransition, SetNextScreenTransition

enum MouseButton {
  eMouseLeft,
  eMouseRight,
  eMouseMiddle,
  eMouseLeftInv,
  eMouseRightInv,
  eMouseWheelNorth,
  eMouseWheelSouth
};
Indique quel bouton de souris a été pressé.

Utilisé par : Mouse.IsButtonDown
Passed into: on_mouse_click

enum EventType {
  eEventLeaveRoom,
  eEventEnterRoom,
  eEventGotScore,
  eEventGUIMouseDown,
  eEventGUIMouseUp,
  eEventAddInventory,
  eEventLoseInventory,
  eEventRestoreGame
};
Indique quel événement s'est produit.

Utilisé par : on_event

enum RoundDirection {
  eRoundDown,
  eRoundNearest,
  eRoundUp
};
Détermine l'arrondissement de la valeur flottante : Down = entier inférieur, Nearest = enter le plus proche, Up = entier supérieur.

Utilisé par : FloatToInt

enum eSpeechStyle {
  eSpeechLucasarts,
  eSpeechSierra,
  eSpeechSierraWithBackground,
  eSpeechFullScreen
};
Correspond au style du discours utilisé par le jeu.

Utilisé par : SetSpeechStyle

enum eVoiceMode {
  eSpeechTextOnly,
  eSpeechVoiceAndText,
  eSpeechVoiceOnly
};
Spécifie la façon dont le mode vocal se comporte.

Utilisé par : SetVoiceMode

enum DialogOptionState {
  eOptionOff,
  eOptionOn,
  eOptionOffForever
};
Indique l'état d'un choix du dialogue : Off = indisponible pour le moment, On = disponible, OffForever = définitivement indisponible.

Utilisé par : GetDialogOption, SetDialogOption

enum CutsceneSkipType {
  eSkipESCOnly,
  eSkipAnyKey,
  eSkipMouseClick,
  eSkipAnyKeyOrMouseClick,
  eSkipESCOrRightButton
};
Spécifique par quels moyens une scène cinématique peut être passée.

Utilisé par : StartCutscene

enum eCDAudioFunction {
  eCDIsDriverPresent,
  eCDGetPlayingStatus,
  eCDPlayTrack,
  eCDPausePlayback,
  eCDResumePlayback,
  eCDGetNumTracks,
  eCDEject,
  eCDCloseTray,
  eCDGetCDDriveCount,
  eCDSelectActiveCDDrive
};
Correspond au type d'interaction avec le CD audio et le lecteur.

Utilisé par : CDAudio

enum CursorMode {
  eModeXXXX,
  eModeXXXX,
  ...
};
L'énumération de CursorMode est automatiquement générée suivant les curseurs de souris définis dans l'Editeur AGS dans la fenêtre "Cursors" ("Curseurs"). Le nom du mode de curseur est relevé, tout espace est supprimé, et le texte eMode est ajouté en tant que préfixe (Exemple : eModeLaisserTomber).
Utilisé par : IsInteractionAvailable, ProcessClick, Mouse.ChangeModeGraphic, Mouse.ChangeModeHotspot, Mouse.DisableMode, Mouse.EnableMode, Mouse.UseModeGraphic, Mouse.Mode, InventoryItem.IsInteractionAvailable, InventoryItem.RunInteraction, Hotspot.RunInteraction, Object.RunInteraction, Character.RunInteraction

enum LocationType {
  eLocationNothing,
  eLocationHotspot,
  eLocationCharacter,
  eLocationObject
};
Indique quel genre d'élément se trouve à l'endroit : Nothing = rien, Hotspot, Character = Personnage, Object = Objet.

Retourné par : GetLocationType

enum FileMode {
  eFileRead,
  eFileWrite,
  eFileAppend
};
Détermine la façon dont est ouvert un fichier.

Utilisé par : File.Open