Api session event editor overlay set attribute overlay values

From Tygron Support wiki
Jump to navigation Jump to search

API Event to Set which type of item and which attribute a specified ATTRIBUTE Overlay should highlight. The ATTRIBUTE Overlay will highlight each item it finds which is both of the specified maptype as well as has the specified attribute

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Overlay ID (must relate to an ATTRIBUTE Overlay)
1 REQUIRED (Enumeration) MapLink: AREAS, BUILDINGS, NEIGHBORHOODS, NET_LOADS, TERRAINS, ZONES ACTION_LOGS, ACTION_MENUS, ADDRESSES, AREAS, ATTRIBUTE_ACTIONS, BUILDINGS, CHAT_MESSAGES, CINEMATIC_DATAS, CLIENT_WORDS, COSTS, CUSTOM_GEOMETRIES, DEFAULT_WORDS, ERROR_LOGS, EVENT_BUNDLES, EXCEL_SHEETS, FUNCTION_OVERRIDES, FUNCTIONS, GEO_LINKS, GEO_OPTIONS, GEO_PLUGINS, GEO_TIFFS, GLOBALS, HEIGHTS, INCOMES, INDICATORS, LEVEES, MEASUREMENTS, MEASURES, MODEL_DATAS, MODEL_SETS, MONEY_TRANSFERS, NEIGHBORHOODS, NET_CLUSTERS, NET_FUNCTIONS, NET_LINES, NET_LOADS, NET_NODES, NET_SETTINGS, NEURAL_NETWORKS, OVERLAYS, PANELS, PARAMETRIC_DESIGNS, PARAMETRIC_EXAMPLES, PARTICLE_EMITTERS, PLOTS, POPUPS, PROGRESS, PROJECT_ASSETS, RECORDINGS, SCENARIOS, SERVER_WORDS, SETTINGS, SOUNDS, SOURCES, SPECIAL_EFFECTS, SPECIAL_OPTIONS, STAKEHOLDERS, TERRAIN_TYPE_OVERRIDES, TERRAIN_TYPES, TERRAINS, TEXTURES, TIMES, TRIGGERS, UNIT_DATA_OVERRIDES, UNIT_DATAS, UPGRADE_TYPES, WATER_VALUES, WEATHERS, ZIP_CODES or ZONES
2 REQUIRED (String) Attribute to look for

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_attribute_overlay_values/?f=JSON&token=API_TOKEN

with content:

[ 81, "NET_CLUSTERS", "Attribute to look for" ]