Thème de la carte
Description
Ce composant représente le thème visuel de la carte.
| Nom | Type | Défaut | Description |
|---|---|---|---|
| couleur du sol | chaîne de caractères | #FFFFFF | Couleur de la terre sous forme de code hexadécimal |
| Capacité de la terre | nombre | 1 | Plage d'opacité de la terre (0,0 - 1,0) |
| visibilité des terres | booléen | vrai | Visibilité du terrain |
| couleur du bâtiment | chaîne de caractères | #FFFFFF | Couleur des bâtiments sous forme de code hexadécimal |
| capacité de construction | nombre | 1 | Plage d'opacité des bâtiments (0,0 - 1,0) |
| bâtimentMinMètres | nombre | 6 | Hauteur minimale des bâtiments en mètres |
| bâtimentMaxMètres | nombre | 6 | Hauteur maximale des bâtiments en mètres |
| constructionVisibilité | booléen | vrai | Visibilité des bâtiments |
| base de construction | nombre | 0.014 | Hauteur de la base des bâtiments, décalée par rapport au terrain |
| couleur du parc | chaîne de caractères | #FFFFFF | Couleur des parcs sous forme de code hexadécimal |
| capacité du parc | nombre | 1 | Plage d'opacité des parcs (0,0 - 1,0) |
| visibilité du parc | booléen | vrai | Visibilité du parc sous forme de case à cocher |
| parkBase | nombre | 0.002 | Hauteur du parc, décalage par rapport au terrain |
| couleur du parking | chaîne de caractères | #FFFFFF | Couleur des parkings sous forme de code hexadécimal |
| capacité de stationnement | nombre | 1 | Plage d'opacité des parkings (0,0 - 1,0) |
| parkingVisibilité | booléen | vrai | Visibilité des parkings |
| parkingBase | nombre | 0.008 | Hauteur des parkings, décalage par rapport au terrain |
| transitColor | chaîne de caractères | #FFFFFF | Couleur des lignes de transport en commun sous forme de code hexadécimal |
| capacité de transit | nombre | 1 | Plage d'opacité des lignes de transit (0,0 - 1,0) |
| visibilité du transit | booléen | vrai | Visibilité des lignes de transport en commun |
| TransitMeters | nombre | 6 | Largeur en mètres des lignes de transport en commun |
| transitBase | nombre | 0.012 | Hauteur des lignes de transport en commun, décalage par rapport au terrain |
| transitMin | nombre | 0 | Largeur minimale des lignes de transport en commun dans le système de cartographie, lors d'un zoom arrière |
| couleur de la route | chaîne de caractères | #FFFFFF | Couleur des routes sous forme de code hexadécimal |
| capacité de la route | nombre | 1 | Plage d'opacité des routes (0,0 - 1,0) |
| visibilité de la route | booléen | vrai | Visibilité des routes |
| roadSMeters | nombre | 2 | Largeur en mètres des routes S |
| roadMMeters | nombre | 4 | Largeur en mètres des routes M |
| compteurs routiers | nombre | 8 | Largeur en mètres des routes L |
| routeXLMètres | nombre | 32 | Largeur en mètres des routes XL |
| roadSMin | nombre | 0 | Largeur minimale des unités du système de cartographie pour les routes S, en cas de zoom arrière |
| roadMMin | nombre | 0 | Largeur minimale de l'unité du système de cartographie pour les routes M, lors d'un zoom arrière |
| routeLMin | nombre | 0 | Largeur minimale de l'unité du système de cartographie pour les routes L, lors d'un zoom arrière |
| routeXLMin | nombre | 0 | Largeur minimale des unités du système cartographique pour les routes XL, en cas de zoom arrière |
| roadBase | nombre | 0.01 | Hauteur des routes, décalage par rapport au terrain |
| couleur sable | chaîne de caractères | #FFFFFF | Couleur du sable en code hexadécimal |
| capacité de sable | nombre | 1 | Plage d'opacité du sable (0,0 - 1,0) |
| visibilité du sable | booléen | vrai | Visibilité du sable |
| base de sable | nombre | 0.004 | Hauteur du sable, décalage par rapport au sol |
| couleur de l'eau | chaîne de caractères | #FFFFFF | Couleur des voies navigables sous forme de code hexadécimal |
| capacité de l'eau | nombre | 1 | Plage d'opacité des voies navigables (0,0 - 1,0) |
| visibilité de l'eau | booléen | vrai | Visibilité des voies d'eau |
| largeur de l'eau | nombre | 6 | Largeur en mètres des voies d'eau |
| base d'eau | nombre | 0.006 | Hauteur des voies d'eau, décalage par rapport à la terre |
| eauMin | nombre | 0 | Largeur minimale des voies d'eau dans le système de cartographie, lors d'un zoom arrière |
| gîte | nombre | 1 | Niveau de détail. Un LOD supérieur à 1 rendra moins de données de tuiles (moins de détails), tandis qu'un LOD inférieur à 1 rendra plus de données de tuiles (plus de détails). La limite de détection doit être supérieure à 0. |
Fonctions
Get
Returns a read-only reference.
Example
ecs.MapTheme.get(world, component.eid)
Set
Ensures the component exists on the entity, then assigns the (optional) data to the component.
Example
ecs.MapTheme.set(world, component.eid, {
landColor: '#AEC988',
buildingColor: '#EFEFEA',
parkColor: '#80B063',
buildingOpacity: 0.4,
buildingMinMeters: 6,
buildingMaxMeters: 50
})
Mutate
Perform an update to the component within a callback function. Return true to indicate no changes made.
Example
ecs.MapTheme.mutate(world, component.eid, (cursor) => {
cursor.buildingColor = '#FFFFFF' ;
cursor.transitColor = '#000000' ;
return false;
})
Remove
Removes the component from the entity.
Example
ecs.MapTheme.remove(world, component.eid)
Has
Returns true if the component is present on the entity.
Example
ecs.MapTheme.has(world, component.eid)
Reset
Adds, or resets the component to its default state.
Example
ecs.MapTheme.reset(world, component.eid)
Advanced Functions
Cursor
Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.
Example
ecs.MapTheme.cursor(world, component.eid)
Acquire
Same behavior as cursor, but commit must be called after the cursor is done being used.
Example
ecs.MapTheme.acquire(world, component.eid)
Commit
Called after acquire. An optional third argument determines whether the cursor was mutated or not.
Example
ecs.MapTheme.commit(world, component.eid)
ecs.MapTheme.commit(world, component.eid, false)
Dirty
Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.
Example
ecs.MapTheme.dirty(world, component.eid)