Api session event logic: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
51,321 edits
No edit summary
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event logic Endpoints.
<noinclude lang="text" copy>API Endpoint: api/session/event/logic/
 
</noinclude><noinclude lang="text" copy>
API End[[#Api Model Point|Point]]s for End[[#Api Model Point|Point]]s changing [[Function]]ality in a testrun/impact [[Session]].
API Endpoints for Endpoints that change Functionality in a testrun or impact [[Session]]
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event logic action log export|action_log_export]]
| [[Api session event logic action log export|action_log_export]]
|Export history of [[Action]]s taken by participants.
| Export history of [[Action]]s taken by [[Stakeholder]]s
|-
|-
|[[Api session event logic action menu set function available|action_menu_set_function_available]]
| [[Api session event logic action menu set function available|action_menu_set_function_available]]
|Add or remove a [[Function]] from a particular [[Action Menu]].
| Add or remove a [[Function]] from an [[Action Menu]]
|-
|-
|[[Api session event logic action menu set measure available|action_menu_set_measure_available]]
| [[Api session event logic action menu set measure available|action_menu_set_measure_available]]
|Add or remove a [[Measure]] from a particular [[Action Menu]].
| Add or remove a [[Measure]] from an [[Action Menu]]
|-
|-
|[[Api session event logic action menu set upgrade available|action_menu_set_upgrade_available]]
| [[Api session event logic action menu set upgrade available|action_menu_set_upgrade_available]]
|Add or remove an upgrade from a particular [[Action Menu]].
| Add or remove an [[Upgrade Type]] from an [[Action Menu]]
|-
|-
|[[Api session event logic area set active|area_set_active]]
| [[Api session event logic area set active|area_set_active]]
|Activate/deactivate a [[Area]].
| Activate/deactivate an [[Area]]
|-
|-
|[[Api session event logic area set attribute|area_set_attribute]]
| [[Api session event logic area set attribute|area_set_attribute]]
|Set [[Area]] [[Attribute]] to given number Value.
| Set an [[Area]] [[Attribute]] to the provided values
|-
|-
|[[Api session event logic areas set attributes|areas_set_attributes]]
| [[Api session event logic areas set attributes|areas_set_attributes]]
|Per entry in the array, set the value of the [[Attribute]] for the [[Area]].
| Per entry in the array, set the value of the [[Attribute]] for the [[Area]]
|-
|-
|[[Api session event logic building set attribute|building_set_attribute]]
| [[Api session event logic building set attribute|building_set_attribute]]
|Set [[Building]] [[Attribute]] to given number Value.
| Set a [[Building]] [[Attribute]] to the specified value
|-
|-
|[[Api session event logic building set attributes|building_set_attributes]]
| [[Api session event logic building set attributes|building_set_attributes]]
|Per entry in the array, set the values of the [[Attribute]] for the [[Building]].
| Per entry in the array, set the values of the [[Attribute]] for the [[Building]]
|-
|-
|[[Api session event logic cinematic reached point|cinematic_reached_point]]
| [[Api session event logic cinematic reached point|cinematic_reached_point]]
|Flight[[#Api Model Point|Point]] reached for a specific [[Cinematic]].
| Notify a [[Key Point]] is reached for a [[Cinematic]]
|-
|-
|[[Api session event logic cinematic stakeholder start|cinematic_stakeholder_start]]
| [[Api session event logic cinematic stakeholder start|cinematic_stakeholder_start]]
|Start a [[Cinematic]] for a specific [[Stakeholder]].
| Start a [[Cinematic]] for a [[Stakeholder]]
|-
|-
|[[Api session event logic cinematic stakeholder stop|cinematic_stakeholder_stop]]
| [[Api session event logic cinematic stakeholder stop|cinematic_stakeholder_stop]]
|Stop any [[Cinematic]] for a specific [[Stakeholder]].
| Stop a playing [[Cinematic]] for a [[Stakeholder]]
|-
|-
|[[Api session event logic dismiss error|dismiss_error]]
| [[Api session event logic dismiss error|dismiss_error]]
|Dismiss [[Error Log]].
| Dismiss an [[Error Log]]
|-
|-
|[[Api session event logic global set value|global_set_value]]
| [[Api session event logic global set value|global_set_value]]
|Set [[Global]] Variable to given number Value.
| Set the [[Global]] to the specified value
|-
|-
|[[Api session event logic global set values|global_set_values]]
| [[Api session event logic global set values|global_set_values]]
|Set [[Global]] Variable to given number Values.
| Set the [[Global]] to the specified values
|-
|-
|[[Api session event logic map direct sell land|map_direct_sell_land]]
| [[Api session event logic map direct sell land|map_direct_sell_land]]
|Direct sale of land, no approval asked.
| Directly sell land without requiring approval
|-
|-
|[[Api session event logic measurement item add|measurement_item_add]]
| [[Api session event logic measurement item add|measurement_item_add]]
|Add a [[Item]][[Measurement]] for an [[Overlay]].
| Add an [[Item]] [[Measurement]] for an [[Overlay]]
|-
|-
|[[Api session event logic measurement line add|measurement_line_add]]
| [[Api session event logic measurement line add|measurement_line_add]]
|Add a Line[[Measurement]] for an [[Overlay]] for a specific [[Timeframe]].
| Add a Line [[Measurement]] for an [[Overlay]] for a specific [[Timeframe]]
|-
|-
|[[Api session event logic measurement point add|measurement_point_add]]
| [[Api session event logic measurement point add|measurement_point_add]]
|Add a [[#Api Model Point|Point]][[Measurement]] for an [[Overlay]].
| Add a [[Point]] [[Measurement]] for an [[Overlay]]
|-
|-
|[[Api session event logic measurement remove|measurement_remove]]
| [[Api session event logic measurement remove|measurement_remove]]
|Remove a [[Measurement]].
| Remove a [[Measurement]]
|-
|-
|[[Api session event logic measurement save|measurement_save]]
| [[Api session event logic measurement save|measurement_save]]
|Save a [[Measurement]].
| Save a [[Measurement]]
|-
|-
|[[Api session event logic measurement set overlays|measurement_set_overlays]]
| [[Api session event logic measurement set overlays|measurement_set_overlays]]
|Set base [[Overlay]]s for an existing [[Measurement]].
| Set base [[Overlay]]s for a [[Measurement]]
|-
|-
|[[Api session event logic measurement set sum|measurement_set_sum]]
| [[Api session event logic measurement set sum|measurement_set_sum]]
|Set a [[Measurement]] to add its base [[Overlay]]s to itself.
| Set a [[Measurement]] to add its base [[Overlay]]s to itself
|-
|-
|[[Api session event logic money transfer add|money_transfer_add]]
| [[Api session event logic money transfer add|money_transfer_add]]
|Create a new [[Money Transfer]] between two [[Stakeholder]]s.
| Create a [[Money Transfer]] between two [[Stakeholder]]s
|-
|-
|[[Api session event logic money transfers set approved|money_transfers_set_approved]]
| [[Api session event logic money transfers set approved|money_transfers_set_approved]]
|Approve a [[Money Transfer]]
| Approve a [[Money Transfer]]
|-
|-
|[[Api session event logic neighborhood set attribute|neighborhood_set_attribute]]
| [[Api session event logic neighborhood set attribute|neighborhood_set_attribute]]
|Set an [[Attribute]] for a [[Neighborhood]].
| Set an [[Attribute]] for a [[Neighborhood]]
|-
|-
|[[Api session event logic net cluster set fraction connected|net_cluster_set_fraction_connected]]
| [[Api session event logic net cluster set fraction connected|net_cluster_set_fraction_connected]]
|Set the fr[[Action]] of connected loads with a cluster.
| Set the fraction of connected loads with a [[Net Cluster]]
|-
|-
|[[Api session event logic net cluster set load attribute|net_cluster_set_load_attribute]]
| [[Api session event logic net cluster set load attribute|net_cluster_set_load_attribute]]
|For each [[Net Load]] of a [[Net Cluster]], set the value of the [[Attribute]].
| For each [[Net Load]] of a [[Net Cluster]], set the value of the [[Attribute]]
|-
|-
|[[Api session event logic net cluster set load attributes|net_cluster_set_load_attributes]]
| [[Api session event logic net cluster set load attributes|net_cluster_set_load_attributes]]
|For each [[Net Load]] of a [[Net Cluster]], set the values of the provided [[Attribute]]s.
| For each [[Net Load]] of a [[Net Cluster]], set the values of the provided [[Attribute]]s
|-
|-
|[[Api session event logic net clusters set default fraction connected|net_clusters_set_default_fraction_connected]]
| [[Api session event logic net clusters set default fraction connected|net_clusters_set_default_fraction_connected]]
|Set the default fr[[Action]] of connected loads with a cluster.
| Set the default fraction of connected loads with a cluster
|-
|-
|[[Api session event logic net clusters set load attributes|net_clusters_set_load_attributes]]
| [[Api session event logic net clusters set load attributes|net_clusters_set_load_attributes]]
|Per [[Net Cluster]], for each [[Net Load]] of that [[Net Cluster]], set the values of the provided [[Attribute]]s.
| Set the provided [[Attribute]] values for each [[Net Load]] within the specified [[Net Cluster]]s
|-
|-
|[[Api session event logic net clusters set state|net_clusters_set_state]]
| [[Api session event logic net clusters set state|net_clusters_set_state]]
|Per [[Net Cluster]], set all its [[Net Load]]s of the provided [[Net Type]] to the given [[Timestate]].
| Per [[Net Cluster]], set all its [[Net Load]]s of the provided [[Net Type]] to the given [[Timestate]]
|-
|-
|[[Api session event logic net line set attribute|net_line_set_attribute]]
| [[Api session event logic net line set attribute|net_line_set_attribute]]
|Set the [[Attribute]] of a [[Net Line]] to the provided value.
| Set the [[Attribute]] of a [[Net Line]] to a value
|-
|-
|[[Api session event logic net lines set attribute|net_lines_set_attribute]]
| [[Api session event logic net lines set attribute|net_lines_set_attribute]]
|For each [[Net Line]], set the value of the [[Attribute]].
| For each [[Net Line]], set the value of the [[Attribute]]
|-
|-
|[[Api session event logic net lines set attributes|net_lines_set_attributes]]
| [[Api session event logic net lines set attributes|net_lines_set_attributes]]
|Per entry in the array, set the value of the [[Attribute]] for the [[Net Line]].
| Per entry in the array, set the value of the [[Attribute]] for the [[Net Line]]
|-
|-
|[[Api session event logic scenario set active|scenario_set_active]]
| [[Api session event logic scenario set active|scenario_set_active]]
|Activate a level.
| Activate a [[Scenario]]
|-
|-
|[[Api session event logic scenario set attribute|scenario_set_attribute]]
| [[Api session event logic scenario set attribute|scenario_set_attribute]]
|Set [[Scenario]] [[Attribute]] to given number Value.
| Set the [[Scenario]] [[Attribute]] to the specified numeric value
|-
|-
|[[Api session event logic search|search]]
| [[Api session event logic search|search]]
|Search for [[Neighborhood]], [[Building]] or [[Address]].
| Search for [[Neighborhood]], [[Building]] or [[Address]]
|-
|-
|[[Api session event logic session release|session_release]]
| [[Api session event logic session release|session_release]]
|Release a client from a [[Session]] using its client token.
| Release a client from a [[Session]] using its client token
|-
|-
|[[Api session event logic set net setting boolean|set_net_setting_boolean]]
| [[Api session event logic set net setting boolean|set_net_setting_boolean]]
|For boolean valued [[Net Setting]]s (ELECTRICITY_ACTIVE, GAS_ACTIVE, HEAT_ACTIVE, INTERNET_ACTIVE, SEWER_ACTIVE, REQUIRE_UTILITY_CORPORATION_APPROVAL, CLUSTER_MODELS_ENABLED, LOAD_TO_NODE_LINES_ENABLED, FIRST_CONNECT_ACCEPT, RESTRICT_TO_NET_[[Overlay]]), set the value to true or false.
| Set a boolean value for the specified [[Net Setting]]
|-
|-
|[[Api session event logic set traffic multiplier|set_traffic_multiplier]]
| [[Api session event logic set traffic multiplier|set_traffic_multiplier]]
|Multiply visual (only) traffic density with this factor.
| Multiply the visual traffic density by a factor
|-
|-
|[[Api session event logic special effect set active|special_effect_set_active]]
| [[Api session event logic special effect set active|special_effect_set_active]]
|Activate/deactivate a [[Special Effect]].
| Activate/deactivate a [[Special Effect]]
|-
|-
|[[Api session event logic stakeholder release|stakeholder_release]]
| [[Api session event logic stakeholder release|stakeholder_release]]
|Release a [[Stakeholder]] from a [[Session]].
| Release a [[Stakeholder]] from a [[Session]]
|-
|-
|[[Api session event logic stakeholder select|stakeholder_select]]
| [[Api session event logic stakeholder select|stakeholder_select]]
|Select [[Stakeholder]] with preferred ID, when not available fallback to next best.
| Select the preferred [[Stakeholder]] or the next available option if unavailable
|-
|-
|[[Api session event logic undo last building action|undo_last_building_action]]
| [[Api session event logic undo last building action|undo_last_building_action]]
|Undo the last [[Building]] [[Action]] of a [[Stakeholder]].
| Undo the last [[Building]] [[Action]] of a [[Stakeholder]]
|-
|-
|[[Api session event logic unit type set active|unit_type_set_active]]
| [[Api session event logic unit type set active|unit_type_set_active]]
|Activate/deactivate units of a specific type.
| Activate/deactivate units of a specific type
|-
|-
|[[Api session event logic zone set attribute|zone_set_attribute]]
| [[Api session event logic zone set attribute|zone_set_attribute]]
|Set an [[Attribute]] for a [[Zone]].
| Set an [[Attribute]] for a [[Zone]]
|-
|-
|[[Api session event logic zones set attributes|zones_set_attributes]]
| [[Api session event logic zones set attributes|zones_set_attributes]]
|Set [[Attribute]]s to values for [[Zone]]s.
| Set [[Attribute]]s values for [[Zone]]s
|}
|}
{{article end|seealso=*[[Api Events]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:27, 13 November 2026

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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_logic&oldid=98653"