Référence API

Référence API Complète

Également disponible sous une forme abrégée à l'intérieur de 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 reconnait et vous permet d'ouvrir l'éditeur d'actifs correspondant avec Ctrl+Click.

Méthodes de Liste

Créez des listes avec [] ou [value1, value2, ...]. Lisez et réé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 minuteries, des index, des étapes d'animation ou des motifs répétitifs.

Propriétés des Objets

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 de vérifier ou de modifier les données de pixels et la vitesse d'animation du sprite. La plupart des jeux dessinent des sprites dans l'éditeur, mais ces fonctions sont utiles pour des effets procéduraux, le débogage ou des changements simples en cours d'exécution.

Fonctions d'Animation

Les fonctions d'animation fonctionnent 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 (Flip/Rotation)

Les fonctions de transformation changent la façon dont le sprite d'un objet est dessiné sans modifier le sprite lui-même. Elles sont idéales pour réutiliser un sprite dans plusieurs directions.

Le décalage de centre par défaut est [0.5, 0.5], ce qui tourne autour du milieu du sprite. [0, 0] tourne autour de l'emplacement en haut à gauche de l'objet, et [1, 1] tourne autour de location + (width, height).

Avertissement pour les anciens projets : À partir de Tiniest2D 1.8, getRotation() et setRotation() utilisent des angles en degrés au lieu de valeurs de quart de tour. Les colliders d'objets tournés affectent désormais la physique et les requêtes de scène.

Types de Collision

Les types de collision décident comment un objet participe aux contrôles 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 globaux de la scène comme la couleur de fond 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 à partir du script. playAudio() renvoie une poignée 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 devez connaître la taille de la fenêtre ou convertir entre les pixels d'écran et les positions dans le monde. Cela est utile pour le ciblage de la souris, la détection de clics et l'interface utilisateur consciente de la caméra.

Mode Fenêtre

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

Exemple :

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

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

Fonctions UI

L'UI utilise une résolution d'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 d'éléments UI peuvent être empilés avec uiPushElementColor(r, g, b[, a]). Comme le reste de l'UI en mode immédiat, ces remplacements s'appliquent pendant la construction de l'UI du cadre actuel. Si la taille poussée est 0 ou moins, le moteur utilise une taille 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é. Habituellement, 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 verticale cohérente quel que soit la taille de l'écran.

Comportement du zoom : Le zoom maintient une vue verticale cohérente quel que soit la taille de la fenêtre ou le ratio 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 d'une seule image, Held pour un mouvement continu, et Released pour des actions qui se produisent lorsque un bouton est relâché.

Constantes des Boutons de la Souris

Les constantes des boutons de la souris sont passées aux fonctions d'entrée de la souris. Elles rendent le code plus lisible que des nombres bruts.

Constantes des Touches

Les constantes des touches sont passées aux fonctions d'entrée du clavier. Le moteur expose les lettres, les chiffres, les touches de fonction, les 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() | Espace | | KEY_ENTER() | Entrée/Retour | | KEY_ESCAPE() | Échap | | KEY_TAB() | Tabulation | | 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 du haut | | KEY_DOWN() | Flèche du bas | | KEY_HOME() | Début | | KEY_END() | Fin |

Fonctions Mathématiques

Les helpers maths couvrent des calculs courants utilisés dans le mouvement, l'animation, l'aléatoire, et les limites de valeur. Ils gardent les scripts plus courts et plus lisibles.

Fonctions Utilitaires

Les fonctions utilitaires sont des aides générales qui n'appartiennent pas à un type d'actif spécifique. print() est particulièrement utile lors de l'apprentissage car il montre ce que votre script est en train de faire.

Fonctions de Chaîne

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

Fonctions de Stockage

Enregistrez et chargez les données de 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 : Sauvegarde et Chargement de la Progression du Joueur

// Sauvegarder 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 sauvegardé !")
}

// 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]
    }
}

// Sauvegarde chiffrée (pour cacher les données d'une inspection décontractée)
var secretData = ["secret", 12345]
save(getAppDataPath() + "/MyGame/config.dat", secretData, "binary", "mySecretKey")
var decrypted = load(getAppDataPath() + "/MyGame/config.dat", "mySecretKey")

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

Remarques :

• Le format binaire (par défaut) est compact et plus rapide
• Le format texte est lisible par l'humain, utile pour le débogage
• Une mauvaise clé de cryptage retourne null (les données seront indéchiffrables)
• Les répertoires sont créés automatiquement lors de la sauvegarde