Documentation pour la création d'applications externes Twinoid.

Référence concernant la création et la gestion des applications Twinoid disponible ici http://twinoid.com/developers/api.

Les accès

Format des données

Status

{
  	attack:Bool,//flag qui précise si le jeu est sous l'effet d'une attaque
 	maintain:Bool,//flag qui précise si le jeu est sous maintenance
}

Map

{
 	id:Int,//ID de la map de jeu
date:Date,//heure du serveur
 	wid:Int,//dimension de la carte
 	hei:Int,//dimension de la carte
 	bonusPts:Int,//points bonus
 	days:Int,//jour de la ville	
custom:Bool,//booléen qui indique si la ville est privée ou non
 	zones:Array<Zone>,//liste des zones connues
 	citizens:Array<User>,//liste des citoyens
 	city:City,//informations de la ville
 	cadavers:Array<Cadaver>,//liste des cadavres
 	expeditions:Array<Expedition>,//liste des expeditions
}

City

{
 	name:String,//Nom de la ville
 	water:Int,//Nombre de rations d'eau disponibles
 	x:Int,//position de la ville
 	y:Int,//position de la ville
 	door:Bool,//flag qui précise si la porte de la ville est ouverte
 	chaos:Bool,//flag qui précise que la ville est en chaos
 	chaos:Bool,//flag qui précise que la ville est en chaos
 	hard:Bool,//flag qui dit si la ville est pandémonium
 	devast:Bool,//flag qui précise si la ville est dévastée
chantiers:Array<{resources:Array<{ amout:Int, rsc:Resource }>, actions:Int, name:String, desc:String, def:Int>,//liste complète des chantiers
 	buildings:Array<Chantier>,//liste des chantiers construits
 	news:{z:Int, def:Int, content:String},//dernière gazette avec informations sur l'attaque et la défense
 	defense:{total:Int, base:Int, buildings:Int,upgrades:Int, items:Int, itemsMul:Int,citizen_homes:Int, citizen_guardians:Int, watchmen:Int},//informations sur la défense de la ville
 	upgrades: {total:Int, list:Array<CityUpgrade>},
 	estimations: {days:Int, min:Int, max:Int, maxed:Bool},
estimationsNext: {days:Int, min:Int, max:Int, maxed:Bool},
 	bank:Array<Item>,//items présents dans la banque
}

Chantier

{
 	id:Int, 
 	icon:String,
 	pa:Int,//nombre de PA nécéssaires à sa construction
 	life:Int,//points de vie actuels du chantier
 	maxLife:Int,
 	votes:Int,//votes récoltés pour ce chantier
 	breakable:Bool,//si ce bâtiment pourra être cassé après l'attaque
 	def:Int,//defense de ce bâtiment
 	hasUpgrade:Bool,//si ce bâtiment peut évoluer
 	rarity:String,//rareté du plan 
 	resources:Array<{ amout:Int, rsc:Resource }>,
 	desc:String,
 	name:String, 
 	icon:String, 
 	temporary:Bool,
 	parent:Null<Int> 
}

Resource

{
 	id:Int, 
 	category:String,
 	desc:String,
 	icon:String,
 	heavy:Bool,
}

CityUpgrade

{
 	name:String,
 	level:Int,
 	update:String,
 	buildingId:Int,
}

Zone

{
 	details:{z:Int, h:Int, dried:Bool},//details sur le nombre de zombies, d'humains et sur l'assèchement de la zone
 	items:Array<Item>,//liste des items dans cette zone
 	building:{type:Int, name:String, dig:Int, desc:String},//informations sur le bâtiment présent sur la zone	
}

Item

{
 	id:Int,//ID de l'objet
 	name:String,//nom de l'objet
 	count:Int,//nombre de fois où cet objet est présent
 	broken:Bool,//flag spécifiant si l'objet est cassé
 	img:String,//url de l'icône de l'objet
 	cat:String,//catégorie de l'objet
}

Expedition

{
 	name:String,//nom de l'expédition
 	author:User,//l'auteur
 	length:Int,//longueur de l'expédition
 	points:Array< {x:Int, y:Int} >,//points définisant le parcours
}

User

{
 	name:String,
isGhost:Bool,//si le joueur est incarné (false) ou non (true)
 	twinId:Int,
 	mapId:Int,
 	map:Map,
homeMessage:String,
 	avatar:String,
 	hero:Bool,
 	dead:Bool,
 	job:String,
 	out:Bool,
 	baseDef:Int,
 	ban:Bool,
 	x:Int,
 	y:Int,
 	playedMaps:Array<Cadaver>,
}

Cadaver

{
 	m:String,//message de mort
 	id:Int,//ID de la map
twinId:Int,//ID twinoid du joueur
avatar:String,
 	name:String,//nom de la map
 	v1:Bool,//vrai si ce cadavre provient de la V1 du jeu
 	d:Int,//nombre de jours survécus
 	score:Int,//score
 	season:Int,//saison de jeu concernée
dtype:Int,//identifiant de type de mort
cleanup : {user:String, type:String='garbage|water'},//information sur la destruction du cadavre
}