Api session items actionmenus: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 76: Line 76:
!Description
!Description
|-
|-
|attributeActionIDs
| attributeActionIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Attribute Action]]s ID  
| [[Attribute Action]]s ID  
|-
|-
|buildable
| buildable
|Map&lt;int,java.util.List<java.lang.Integer>&gt;
| Map&lt;int,java.util.List<java.lang.Integer>&gt;
|
|  
|-
|-
|color
| color
|TColor
| TColor
|
|  
|-
|-
|eventBundleIDs
| eventBundleIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Event Bundle]]s ID  
| [[Event Bundle]]s ID  
|-
|-
|functionIDs
| functionIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Function]]s ID  
| [[Function]]s ID  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|imageName
| imageName
|String
| String
|
|  
|-
|-
|imageVersion
| imageVersion
|int
| int
|
|  
|-
|-
|leveeIDs
| leveeIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Levee]]s ID  
| [[Levee]]s ID  
|-
|-
|measureIDs
| measureIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Measure]]s ID  
| [[Measure]]s ID  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|sortIndex
| sortIndex
|int
| int
|
|  
|-
|-
|specialOptions
| specialOptions
|Type<nowiki>[]</nowiki>
| Type<nowiki>[]</nowiki>
|
|  
|-
|-
|upgradeIDs
| upgradeIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Upgrade Type]]s ID  
| [[Upgrade Type]]s ID  
|-
|-
|version
| version
|int
| int
|
|  
|}
|}


Line 153: Line 153:
!Description
!Description
|-
|-
|BUY_LAND
| BUY_LAND
|
|  
|-
|-
|SELL_LAND
| SELL_LAND
|
|  
|-
|-
|DEMOLISH
| DEMOLISH
|
|  
|-
|-
|REVERT
| REVERT
|
|  
|-
|-
|DEMOLISH_UNDERGROUND
| DEMOLISH_UNDERGROUND
|
|  
|-
|-
|RAISE_LAND
| RAISE_LAND
|
|  
|-
|-
|SHOW_BUDGETPANEL
| SHOW_BUDGETPANEL
|
|  
|-
|-
|SHOW_MONEY_TRANSFER_PANEL
| SHOW_MONEY_TRANSFER_PANEL
|
|  
|-
|-
|LOWER_LAND
| LOWER_LAND
|
|  
|}
|}



Revision as of 11:44, 8 June 2026

API Endpoint: /api/session/items/actionmenus/

Edit items with events described at Api session event editor actionmenu.

Default Query:

https://engine.tygron.com/api/session/items/actionmenus/?f=JSON&token=API_TOKEN

Example Response:

[ {
  "attributeActionIDs" : [ ],
  "buildable" : {
    "0" : [ 0 ]
  },
  "color" : null,
  "eventBundleIDs" : [ ],
  "functionIDs" : [ 436, 438 ],
  "id" : 0,
  "imageName" : "category_road.png",
  "imageVersion" : 0,
  "leveeIDs" : [ ],
  "measureIDs" : [ ],
  "name" : "Roads",
  "sortIndex" : 1,
  "specialOptions" : [ ],
  "upgradeIDs" : [ ],
  "version" : 16
}, {
  "attributeActionIDs" : [ ],
  "buildable" : {
    "0" : [ 0 ]
  },
  "color" : null,
  "eventBundleIDs" : [ ],
  "functionIDs" : [ 77 ],
  "id" : 1,
  "imageName" : "category_heart.png",
  "imageVersion" : 0,
  "leveeIDs" : [ ],
  "measureIDs" : [ ],
  "name" : "Leisure",
  "sortIndex" : 2,
  "specialOptions" : [ ],
  "upgradeIDs" : [ ],
  "version" : 17
} ]

Limit Queries

version=100:

https://engine.tygron.com/api/session/items/actionmenus/?version=100&token=API_TOKEN

Show Queries

max version:

https://engine.tygron.com/api/session/items/actionmenus/version/?token=API_TOKEN

size:

https://engine.tygron.com/api/session/items/actionmenus/size/?token=API_TOKEN

Action Menus (GeoJSON):

https://engine.tygron.com/web/actionmenus.geojson?token=API_TOKEN

Formats

HTML:

https://engine.tygron.com/api/session/items/actionmenus/?f=HTML&token=API_TOKEN

JSON:

https://engine.tygron.com/api/session/items/actionmenus/?f=JSON&token=API_TOKEN

CSV:

https://engine.tygron.com/api/session/items/actionmenus/?f=CSV&token=API_TOKEN

SSV:

https://engine.tygron.com/api/session/items/actionmenus/?f=SSV&token=API_TOKEN

SMILE:

https://engine.tygron.com/api/session/items/actionmenus/?f=SMILE&token=API_TOKEN

ZIPJSON:

https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE:

https://engine.tygron.com/api/session/items/actionmenus/?f=ZIPSMILE&token=API_TOKEN

Api Model ActionMenu

API Model description of ActionMenu

Name Type Description
attributeActionIDs int[] Attribute Actions ID
buildable Map<int,java.util.List<java.lang.Integer>>
color TColor
eventBundleIDs int[] Event Bundles ID
functionIDs int[] Functions ID
id int
imageName String
imageVersion int
leveeIDs int[] Levees ID
measureIDs int[] Measures ID
name String
sortIndex int
specialOptions Type[]
upgradeIDs int[] Upgrade Types ID
version int

Api Model TColor

API Model description of TColor

Name Type Description

Api Model Type (SpecialOption)

API Enumeration description of Type

Name Description
BUY_LAND
SELL_LAND
DEMOLISH
REVERT
DEMOLISH_UNDERGROUND
RAISE_LAND
SHOW_BUDGETPANEL
SHOW_MONEY_TRANSFER_PANEL
LOWER_LAND