Tiled 1.2.x object properties backwards compatibility issues #2034

Activity

1. Larkenx commented on Nov 15, 2018

   

   Larkenx

   on Nov 15, 2018

   Author

   More actions

   Here's some more supporting examples of how I used the previous implementation of properties for objects. This is a code snippet that takes one of these objects, creates either an Actor or Item from the object, and places it in the game.

   createActorFromObject(object) {
   		const { gid, x, y, properties } = object
   		if (properties.entity_type === undefined) {
   			console.error(`No entity type given in properties for object ${object}`)
   			return
   		}
   		const { entity_type } = properties
   		let nx = x / 32
   		let ny = y / 32 - 1 // for some reason, TILED objects y position are 1-indexed..?
   		let entity = properties.item ? createItem(entity_type, nx, ny, gid - 1) : createActor(entity_type, nx, ny, gid - 1)
   		if (properties.item) entity.inInventory = false
   		if (properties.items !== undefined) {
   			let items = properties.items.split(',').map(i => createItem(i.trim(), nx, ny))
   			items.forEach(item => entity.addToInventory(item))
   		}
   		/* Post entity creation clean up... */
   		if (entity_type === 'NPC') {
   			// add NPC routines if any exist...
   			// NPCs may have items too!
   			entity.wanders = properties.wanders
   			if (properties.dialog !== undefined) {
   				const dialogID = properties.dialog
   				if (dialogID in DIALOGUES) {
   					entity.dialogData = DIALOGUES[dialogID]
   					entity.dialogBubbleEnabled = 'dialogBubbleEnabled' in properties ? properties.dialogBubbleEnabled : true
   					if ('bubbleData' in properties) {
   						let [id, animated_id] = properties.bubbleData.split(',')
   						entity.bubbleData = { id, animated_id }
   					} else {
   						entity.bubbleData = null
   					}
   				}
   			}
   		} else if (entity_type === 'LADDER' || entity_type === 'LEVEL_TRANSITION') {
   			// ladders & level transitions have portal ID's
   			entity.portal = properties.portalID
   			entity.createDungeon = properties.createDungeon
   			if (entity_type === 'LADDER') entity.direction = properties.direction
   		}
   		this.getTile(nx, ny).actors.push(entity)
   	}
2. Larkenx

   changed the title [-]Tiled 1.2.1 massive backwards compatibility issues[/-] [+]Tiled 1.2.x object properties massive backwards compatibility issues[/+] on Nov 15, 2018
3. Larkenx

   changed the title [-]Tiled 1.2.x object properties massive backwards compatibility issues[/-] [+]Tiled 1.2.x object properties backwards compatibility issues[/+] on Nov 15, 2018
4. bjorn commented on Nov 15, 2018

   

   bjorn

   on Nov 15, 2018

   Member

   More actions

   I'm sorry that this compatibility change affected your project and likely wasted some of your time. I did mention it in the blog post about the Tiled 1.2 release under "Compatibility Notes" and provided details on the JSON format page.

   It wasn't only Unity that was having trouble parsing the old format, but generally all annotation-based automated parsing systems would have trouble dealing with JSON objects with arbitrary members. Also, the properties had become quite a mess with the additional propertytypes and tilepropertytypes members. Hence I'm reluctant to re-introduce support for the old format, even though I understand it was easier previously to access the properties in dynamically typed languages like JavaScript.

   Fortunately, it should be easy to support both formats in the map loader. After you have loaded the JSON, you could iterate your objects and perform the following kind of operation:

   function ensureObject(properties) {
       if (Array.isArray(properties)) {
           const array = properties;
           properties = {};
           for (const p of array)
               properties[p.name] = p.value;
       }
       return properties;
   }
   
   // For each object / tile / layer:
   something.properties = ensureObject(something.properties)

   I hope that helps you support Tiled 1.2 in your game.

   👍React with 👍3Reacted by Steven, Nicolás Pinochet and Jayson Harshbarger
5. Larkenx commented on Nov 15, 2018

   

   Larkenx

   on Nov 15, 2018

   Author

   More actions

   Thanks for your swift response. I can see where this could present some issues across the board for other parsing systems, and where having the unified properties list with its respective type present can be really helpful. I'll be sure to do as you suggested above, and add an additional step to parse the properties array into a map as it was before.

   👍React with 👍1Reacted by Thorbjørn Lindeijer
6. Larkenx

   closed this as completedon Nov 15, 2018