Api session event logic

From Tygron Support wiki
Revision as of 10:20, 13 November 2026 by Frank@tygron.nl (talk | contribs)
Jump to navigation Jump to search

API Endpoint: api/session/event/logic/

API Endpoints for Endpoints that change Functionality in a testrun or impact Session

Name Description
action_log_export Export history of Actions taken by Stakeholders
action_menu_set_function_available Add or remove a Function from an Action Menu
action_menu_set_measure_available Add or remove a Measure from an Action Menu
action_menu_set_upgrade_available Add or remove an Upgrade Type from an Action Menu
area_set_active Activate/deactivate an Area
area_set_attribute Set an Area Attribute to the provided values
areas_set_attributes Per entry in the array, set the value of the Attribute for the Area
building_set_attribute Set a Building Attribute to the specified value
building_set_attributes Per entry in the array, set the values of the Attribute for the Building
cinematic_reached_point Notify a Key Point is reached for a Cinematic
cinematic_stakeholder_start Start a Cinematic for a Stakeholder
cinematic_stakeholder_stop Stop a playing Cinematic for a Stakeholder
dismiss_error Dismiss an Error Log
global_set_value Set the Global to the specified value
global_set_values Set the Global to the specified values
map_direct_sell_land Directly sell land without requiring approval
measurement_item_add Add an Item Measurement for an Overlay
measurement_line_add Add a Line Measurement for an Overlay for a specific Timeframe
measurement_point_add Add a Point Measurement for an Overlay
measurement_remove Remove a Measurement
measurement_save Save a Measurement
measurement_set_overlays Set base Overlays for a Measurement
measurement_set_sum Set a Measurement to add its base Overlays to itself
money_transfer_add Create a Money Transfer between two Stakeholders
money_transfers_set_approved Approve a Money Transfer
neighborhood_set_attribute Set an Attribute for a Neighborhood
net_cluster_set_fraction_connected Set the fraction of connected loads with a Net Cluster
net_cluster_set_load_attribute For each Net Load of a Net Cluster, set the value of the Attribute
net_cluster_set_load_attributes For each Net Load of a Net Cluster, set the values of the provided Attributes
net_clusters_set_default_fraction_connected Set the default fraction of connected loads with a cluster
net_clusters_set_load_attributes Set the provided Attribute values for each Net Load within the specified Net Clusters
net_clusters_set_state Per Net Cluster, set all its Net Loads of the provided Net Type to the given Timestate
net_line_set_attribute Set the Attribute of a Net Line to a value
net_lines_set_attribute For each Net Line, set the value of the Attribute
net_lines_set_attributes Per entry in the array, set the value of the Attribute for the Net Line
scenario_set_active Activate a Scenario
scenario_set_attribute Set the Scenario Attribute to the specified numeric value
search Search for Neighborhood, Building or Address
session_release Release a client from a Session using its client token
set_net_setting_boolean Set a boolean value for the specified Net Setting
set_traffic_multiplier Multiply the visual traffic density by a factor
special_effect_set_active Activate/deactivate a Special Effect
stakeholder_release Release a Stakeholder from a Session
stakeholder_select Select the preferred Stakeholder or the next available option if unavailable
undo_last_building_action Undo the last Building Action of a Stakeholder
unit_type_set_active Activate/deactivate units of a specific type
zone_set_attribute Set an Attribute for a Zone
zones_set_attributes Set Attributes values for Zones