Fonctions du TiledLevelManager

Fonction TiledLevelManager.new

Permet de charger une animation à partir d'un spritesheet.

Synopsis

map = TiledLevelManager:new( pFilename )

Paramètres

  • string pFilename : Nom du fichier contenant la map

Retour

Un objet TiledLevelManager prêt à être dessiner à l'écran

 

Fonction TiledLevelManager.draw

Permet d'afficher la map avec un décalage en nombre de lignes et de colonnes.

Synopsis

map:draw ( pRow, pCol )

Arguments

  • number pRow : [optionel, défaut : 0] Décalage en nombre de lignes
  • number pCol : [optionel, défaut : 0] Décalage en nombre de colonnes

Retour

Aucun

 

Fonction TiledLevelManager.getDimensions

Permet de connaître pour une map donnée le nombre de tuiles en largeur et en hauteur et la taille des tuiles en largeur et en hauteur.

Synopsis

mapWidth, mapHeight, tileWidth, tileHieght = map:getDimensions()

Arguments

Aucun

Retour

  • number mapWidth : nombre de tuiles en largeur
  • number mapHeight : nombre de tuiles en hauteur
  • number tileWidth : taille des tuiles en largeur
  • number tileHeight : taille des tuiles en hauteur

 

Fonction TiledLevelManager.getLayerByName

Permet de récupérer un layer identifié par son nom.

Synopsis

layer = map:getLayerByName ( pLayerName )

Arguments

  • string pLayerName : Nom du layer

Retour

object layer : Objet contenant le layer

 

Fonction TiledLevelManager.getObjectByName

Permet de récupérer un objet identifié par son nom.

Synopsis

object = map:getObjectByName ( pObjName )

Arguments

  • string pObjName : Nom de l'objet

Retour

object object : Objet contenant le object

 

Fonction TiledLevelManager.getAllObjectsByType

Permet de récupérer la liste des objets identifiés par leur type.

Synopsis

objects = map:getAllObjectsByType ( pType )

Arguments

  • string pType : Type des objets

Retour

object objects : liste des objets du type donné

 

Fonction TiledLevelManager.getAllObjectsByShape

Permet de récupérer la liste des objets identifiés par leur forme.

Synopsis

objects = map:getAllObjectsByShape ( pShape )

Arguments

  • string pShape : Nom de la forme des objets

Retour

object objects : liste des objets de la forme donnée.

 

Fonction TiledLevelManager.getObjectsOnGrid

Permet de récupérer la liste des objets à une position donnée en ligne/colonne dans la map.

Synopsis

objects = map:getObjectsOnGrid ( pRow, pCol )

Arguments

  • nomber pRow : Numéro de la ligne
  • nomber pCol : Numéro de la colonne

Retour

object objects : liste des objets à la ligne/colonne donnée.

 

Fonction TiledLevelManager.getLayerOpacity

Permet de récupérer la valeur de l'opacité d'un layer, identifié par son nom.

Synopsis

opacity = map:getLayerOpacity ( pLayer )

Arguments

  • object pLayer : Layer à mettre à jour

Retour

number opacity : Valeur de l'opacité comprise entre 0 et 1 inclus

 

Fonction TiledLevelManager.setLayerOpacity

Permet de définir la valeur de l'opacité d'un layer, identifié par son nom..

Synopsis

map:setLayerOpacity ( pLayer , pValue )

Arguments

  • object pLayer : Layer à mettre à jour
  • number pValue : nouvelle valeur pour l'opacité (entre 0 et 1 inclus)

Retour

Aucun

 

Fonction TiledLevelManager.restoreLayerOpacity

Permet de remettre la valeur de l'opacité d'origine d'un layer.

Synopsis

map:restoreLayerOpacity ( pLayer )

Arguments

  • object pLayer : Layer à restaurer

Retour

Aucun

 

Fonction TiledLevelManager.getObjectOpacity

Permet de récupérer la valeur de l'opacité d'un objet, identifié par son nom.

Synopsis

opacity = map:getObjectOpacity ( pObject )

Arguments

  • object pObject : Objet

Retour

number opacity : Valeur de l'opacité comprise entre 0 et 1 inclus

 

Fonction TiledLevelManager.setObjectOpacity

Permet de définir la valeur de l'opacité d'un objet, identifié par son nom..

Synopsis

map:setObjectOpacity ( pObject , pValue )

Arguments

  • object pObject : Objet à mettre à jour
  • number pValue : nouvelle valeur pour l'opacité (entre 0 et 1 inclus)

Retour

Aucun

 

Fonction TiledLevelManager.restoreObjectOpacity

Permet de restaurer l'opacité d'un objet donné.

Synopsis

map:restoreObjectOpacity ( pObject )

Arguments

  • object pObject : Objet à restaurer

Retour

Aucun

 

Fonction TiledLevelManager.setOpacity

Permet de modifier l'opacité pour la carte entière (calques de tuiles, images et objets).

Synopsis

map:setOpacity ( pValue )

Arguments

  • number pValue : nouvelle valeur d'opacité (entre 0 et 1 inclus)

Retour

Aucun

 

Fonction TiledLevelManager.restoreOpacity

Permet de restaurer l'opacité pour la carte entière (calques de tuiles, d'images et objets).

Synopsis

map:restoreOpacity ( )

Arguments

Aucun

Retour

Aucun

 

Fonction TiledLevelManager.getLayerTileIdAtPos

Permet de récupérer la liste des objets identifiés par leur forme.

Synopsis

id = map:getLayerTileIdAtPos ( pLayerName, pRow, pCol )

Arguments

  • string pLayerName : Nom du calque
  • number pRow : Numéro de ligne
  • number pCol : Numéro de colonne

Retour

number id : Id de l'image dans les tilesets

 

Fonction TiledLevelManager.changeObjectImageId

Permet de modifier l'id de l'image utilisée par un objet donné.
Un contrôle est effectué pour vérifier si l'id de l'image appartient à un des tilesets.
Si ce n'est pas le cas, l'image n'est pas modifiée.

Synopsis

map:changeObjectImageId ( pObject , pId )

Arguments

  • object pObject : Objet à modifier
  • number pId : Id de la nouvelle image

Retour

Aucun

 

Fonction TiledLevelManager.restoreObjectImageId

Permet de restaurer l'image par défaut d'un objet donné.

Synopsis

map:restoreObjectImageId ( pObject )

Arguments

  • object pObject : Objet dont l'image d'origine est à restaurer

Retour

Aucun

 

Fonction TiledLevelManager.reload

Permet de restaurer toutes les valeurs par défaut des calques et des objets.

Synopsis

map:reload ( )

Arguments

Aucun

Retour

Aucun

 

Fonction TiledLevelManager.resetObjects

Permet de repositionner tous les objets à leur position d'origine avec leur image et leur opacité d'origine.

Synopsis

map:resetObjects ( )

Arguments

Aucun

Retour

Aucun

Date de dernière mise à jour : 14/01/2018

×