Référence API

Référence API complète

Également disponible sous forme abrégée dans l'Éditeur lui-même :

Constructeurs d'Actifs

Les constructeurs créent les principaux types d'actifs utilisés par l'éditeur. Lorsque vous en assignez un à une variable, l'éditeur le reconnaît et vous permet d'ouvrir l'éditeur d'actif correspondant avec Ctrl+Click.

Méthodes de Liste

Créez des listes avec [] ou [value1, value2, ...]. Lisez et écrivez des entrées avec list[index], et itérez avec for (var i = 0; i < list.length(); i = i + 1).

Opérateurs

Les opérateurs sont de petits symboles qui effectuent des calculs courants. L'opérateur modulo est particulièrement utile pour envelopper des temporisateurs, des index, des étapes d'animation ou des motifs répétitifs.

Propriétés d'Objet

Les objets sont les éléments que votre script déplace et modifie généralement pendant le jeu. Ces fonctions lisent ou mettent à jour la position, le sprite, le comportement de collision, la couche et la teinte visuelle d'un objet.

Fonctions Sprite

Les fonctions sprite permettent au code d'inspecter ou de modifier les données de pixels du sprite et la vitesse d'animation. La plupart des jeux dessinent des sprites dans l'éditeur, mais ces fonctions sont utiles pour des effets procéduraux, du débogage ou des modifications simples à l'exécution.

Fonctions d'Animation

Les fonctions d'animation travaillent sur des objets qui utilisent des sprites avec plusieurs cadres. Utilisez-les lorsque vous souhaitez que le code inspecte ou force le cadre d'animation actuel.

Fonctions de Transformation (Retour/Rotation)

Les fonctions de transformation changent comment le sprite d'un objet est dessiné sans modifier le sprite lui-même. Elles sont bonnes pour réutiliser un sprite dans plusieurs directions.

Remarque : Ces transformations ne sont appliquées qu'au moment du rendu. Elles n'affectent pas les boîtes de collision ou les données de pixels réelles du sprite.

Types de Collision

Les types de collision décident comment un objet participe aux vérifications de collision. Choisissez le type en fonction du rôle de l'objet : les murs sont généralement statiques, les joueurs sont généralement dynamiques, et les objets à ramasser sont souvent des déclencheurs.

Fonctions de Scène

Les fonctions de scène contrôlent quelle scène est active, quels objets y sont présents, et les paramètres de scène comme la couleur d'arrière-plan et la gravité. Elles fournissent également des aides à la recherche pour trouver des objets à des positions ou par nom.

Lecture Audio

Les fonctions de lecture audio démarrent et arrêtent les actifs audio depuis le script. playAudio() renvoie un identifiant de gestionnaire afin que vous puissiez arrêter ou vérifier plus tard cette instance de lecture spécifique.

Fonctions d'Écran

Les fonctions d'écran aident lorsque vous avez besoin de connaître la taille de la fenêtre ou de convertir entre les pixels de l'écran et les positions du monde. Cela est utile pour le ciblage de la souris, la détection des clics et l'interface utilisateur consciente de la caméra.

Mode Fenêtre

Contrôlez le mode de fenêtre pour les jeux exportés. Ces fonctions n'ont aucun effet lors de la lecture dans l'éditeur (l'éditeur a plus d'autorité sur l'état de la fenêtre).

Exemple :

func start() {
    // Définissez le mode de fenêtre (WINDOW_MAXIMIZED est le défaut pour les jeux exportés)
    setWindowMode(WINDOW_MAXIMIZED())
}

Remarque : Si setWindowMode() n'est jamais appelé dans un jeu exporté, la valeur par défaut est WINDOW_MAXIMIZED.

Fonctions UI

L'interface utilisateur utilise une résolution de l'espace écran virtuel. L'espace UI par défaut est 100 x 100. La taille de la police peut être augmentée pour les widgets de texte suivants avec uiPushFontSize(size) et restaurée avec uiPopFontSize(). Les couleurs de police peuvent être empilées avec uiPushFontColor(r, g, b[, a]), et les remplissages des éléments UI peuvent être empilés avec uiPushElementColor(r, g, b[, a]). Comme le reste de l'interface utilisateur en mode immédiat, ces modifications s'appliquent lors de la construction de l'interface utilisateur du cadre actuel. Si la taille empilée est 0 ou inférieure, le moteur utilise un dimensionnement automatique.

Constantes d'état UI

Les fonctions UI renvoient des constantes d'état pour que votre script puisse savoir si un widget est inactif, survolé, maintenu ou cliqué. En général, UI_CLICKED() est la valeur que vous vérifiez pour les actions de bouton.

Fonctions de caméra

La position de la caméra représente le centre de la vue. Le zoom maintient une vue du monde vertical cohérente indépendamment de la taille de l'écran.

Comportement du zoom: Le zoom maintient une vue du monde vertical cohérente indépendamment de la taille de la fenêtre ou du rapport d'aspect. Les écrans plus larges montrent plus horizontalement mais la même quantité verticalement.

Fonctions d'entrée

Les fonctions d'entrée permettent au jeu de réagir à l'état du clavier et de la souris. Utilisez Pressed pour des actions en une seule image, Held pour un mouvement continu, et Released pour des actions qui se produisent lorsqu'un bouton est relâché.

Constantes de bouton de souris

Les constantes de bouton de souris sont passées dans les fonctions d'entrée de la souris. Elles rendent le code plus facile à lire que des nombres bruts.

Constantes de touche

Les constantes de touche sont passées dans les fonctions d'entrée du clavier. Le moteur expose des lettres, des chiffres, des touches de fonction, des flèches et un petit ensemble de touches spéciales courantes.

Lettres: KEY_A() à KEY_Z()

Chiffres: KEY_0() à KEY_9()

Touches de fonction: KEY_F1() à KEY_F12()

Touches spéciales: | Constante | Touche | |----------|-----| | KEY_SPACE() | Barre d'espace | | KEY_ENTER() | Entrée/Retour | | KEY_ESCAPE() | Échapper | | KEY_TAB() | Tabuler | | KEY_BACKSPACE() | Retour arrière | | KEY_DELETE() | Supprimer | | KEY_SHIFT() | Maj | | KEY_CTRL() | Contrôle | | KEY_ALT() | Alt | | KEY_LEFT() | Flèche gauche | | KEY_RIGHT() | Flèche droite | | KEY_UP() | Flèche haut | | KEY_DOWN() | Flèche bas | | KEY_HOME() | Accueil | | KEY_END() | Fin |

Fonctions mathématiques

Les aides mathématiques couvrent les calculs courants utilisés dans le mouvement, l'animation, le hasard et les limites de valeur. Elles maintiennent les scripts plus courts et plus faciles à lire.

Fonctions utilitaires

Les fonctions utilitaires sont des aides générales qui ne relèvent pas d'un type d'actif spécifique. print() est particulièrement utile pendant l'apprentissage car il montre ce que votre script fait.

Fonctions de chaîne

Les fonctions de chaîne fonctionnent avec des valeurs textuelles. Pour l'instant, cette section est intentionnellement petite.

Fonctions de stockage

Enregistrez et chargez les données du jeu dans des fichiers. Prend en charge les nombres, les chaînes, les booléens et les listes (y compris les listes imbriquées). Ne prend PAS en charge les valeurs Sprite, Scene, Object ou Audio.

Exemple : Enregistrement et chargement de la progression du joueur

// Enregistrer les données du joueur
var playerData = [100, "Player1", true, [1, 2, 3]]
var savePath = getAppDataPath() + "/MyGame/save.dat"
if (save(savePath, playerData)) {
    print("Jeu enregistré !")
}

// Charger les données du joueur
if (fileExists(savePath)) {
    var loaded = load(savePath)
    if (loaded != null) {
        var health = loaded[0]
        var name = loaded[1]
        var hasKey = loaded[2]
        var inventory = loaded[3]
    }
}

// Enregistrement chiffré (pour cacher les données d'une inspection occasionnelle)
var secretData = ["secret", 12345]
save(getAppDataPath() + "/MyGame/config.dat", secretData, "binaire", "maCleSecrete")
var decrypted = load(getAppDataPath() + "/MyGame/config.dat", "maCleSecrete")

// Format texte (lisible par l'homme, utile pour le débogage)
save(getAppDataPath() + "/MyGame/debug.txt", playerData, "texte")

Remarques :

• Le format binaire (par défaut) est compact et plus rapide
• Le format texte est lisible par l'homme, utile pour le débogage
• Une mauvaise clé de chiffrement renvoie null (les données seront inutilisables)
• Les répertoires sont créés automatiquement lors de l'enregistrement