Api session event participant: 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
39,237 edits
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event participant Endpoints.
API Endpoint: api/session/event/participant/


API Endpoints for Endpoints for user actions (e.g. build [[Building]]) in a testrun/impact [[Session]].
API endpoints for endpoints for user [[Action]]s (e.g. build [[Building]]) in a testrun/impact [[Session]].
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 7: Line 7:
|-
|-
|[[Api session event participant action menu set active|action_menu_set_active]]
|[[Api session event participant action menu set active|action_menu_set_active]]
|Set a category active for a [[Stakeholder]].
|Set a [[Category]] active for a [[Stakeholder]].
|-
|-
|[[Api session event participant attribute action plan|attribute_action_plan]]
|[[Api session event participant attribute action plan|attribute_action_plan]]
Line 19: Line 19:
|-
|-
|[[Api session event participant building plan demolish polygon|building_plan_demolish_polygon]]
|[[Api session event participant building plan demolish polygon|building_plan_demolish_polygon]]
|Plan the demolition of a [[Building]] in the given polygon in the MAQUETTE map.
|Plan the demolition of a [[Building]]s in the given [[#Api Model Polygon|Polygon]] in the MAQUETTE map.
|-
|-
|[[Api session event participant building plan upgrade|building_plan_upgrade]]
|[[Api session event participant building plan upgrade|building_plan_upgrade]]
|Plan the upgrade of [[Building]] in the given polygon in the MAQUETTE map.
|Plan the upgrade of [[Building]]s in the given [[#Api Model Polygon|Polygon]] in the MAQUETTE map.
|-
|-
|[[Api session event participant building revert polygon|building_revert_polygon]]
|[[Api session event participant building revert polygon|building_revert_polygon]]
|Revert polygon to orginal CURRENT map situation.
|Revert [[#Api Model Polygon|Polygon]] to orginal CURRENT map situation.
|-
|-
|[[Api session event participant event bundle apply server events|event_bundle_apply_server_events]]
|[[Api session event participant event bundle apply server events|event_bundle_apply_server_events]]
Line 31: Line 31:
|-
|-
|[[Api session event participant map buy land|map_buy_land]]
|[[Api session event participant map buy land|map_buy_land]]
|Buy the land definied by the polygon for given price.
|Buy the land definied by the [[#Api Model Polygon|Polygon]] for given price.
|-
|-
|[[Api session event participant map levee|map_levee]]
|[[Api session event participant map levee|map_levee]]
Line 43: Line 43:
|-
|-
|[[Api session event participant map sell land|map_sell_land]]
|[[Api session event participant map sell land|map_sell_land]]
|Buy the land definied by the polygon for given price.
|Buy the land definied by the [[#Api Model Polygon|Polygon]] for given price.
|-
|-
|[[Api session event participant measure cancel construction|measure_cancel_construction]]
|[[Api session event participant measure cancel construction|measure_cancel_construction]]
Line 55: Line 55:
|-
|-
|[[Api session event participant net cluster set load attribute|net_cluster_set_load_attribute]]
|[[Api session event participant 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 participant net cluster set load attributes|net_cluster_set_load_attributes]]
|[[Api session event participant net cluster set load attributes|net_cluster_set_load_attributes]]
|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 participant net cluster set state|net_cluster_set_state]]
|[[Api session event participant net cluster set state|net_cluster_set_state]]
|Set [[Timestate]] for all [[Net Load]] of [[Net Cluster]].
|Set [[Timestate]] for all [[Net Load]]s of [[Net Cluster]].
|-
|-
|[[Api session event participant net cluster set state for net type|net_cluster_set_state_for_net_type]]
|[[Api session event participant net cluster set state for net type|net_cluster_set_state_for_net_type]]
|Set [[Timestate]] for [[Net Load]] of [[Net Cluster]], based on [[Net Type]].
|Set [[Timestate]] for [[Net Load]]s of [[Net Cluster]], based on [[Net Type]].
|-
|-
|[[Api session event participant net cluster set states|net_cluster_set_states]]
|[[Api session event participant net cluster set states|net_cluster_set_states]]
|Set [[Timestate]] for all [[Net Load]] of [[Net Cluster]].
|Set [[Timestate]] for all [[Net Load]]s of [[Net Cluster]].
|-
|-
|[[Api session event participant panel answer|panel_answer]]
|[[Api session event participant panel answer|panel_answer]]
|[[Stakeholder]] has selected an answer in a [[Panel]].
|[[Stakeholder]] has selected an [[Answer (Panel)]] in a [[Panel]].
|-
|-
|[[Api session event participant parametric design plan|parametric_design_plan]]
|[[Api session event participant parametric design plan|parametric_design_plan]]
Line 76: Line 76:
|-
|-
|[[Api session event participant popup answer|popup_answer]]
|[[Api session event participant popup answer|popup_answer]]
|[[Stakeholder]] answers a [[Popup]].
|[[Stakeholder]] [[Answer (Panel)]]s a [[Popup]].
|-
|-
|[[Api session event participant popup answer with date|popup_answer_with_date]]
|[[Api session event participant popup answer with date|popup_answer_with_date]]
|[[Stakeholder]] answers a [[Popup]] with an additional date.
|[[Stakeholder]] [[Answer (Panel)]]s a [[Popup]] with an additional date.
|-
|-
|[[Api session event participant restore land|restore_land]]
|[[Api session event participant restore land|restore_land]]
Line 94: Line 94:
|-
|-
|[[Api session event participant zones set categories|zones_set_categories]]
|[[Api session event participant zones set categories|zones_set_categories]]
|Sets the allowed [[Building]] categories for specified [[Zone]].
|Sets the allowed [[Building]] categories for specified [[Zone]]s.
|}
|}
{{article end|seealso=*[[Api Events]]
{{article end|seealso=*[[Api Session Endpoints]]
}}
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 08:41, 3 June 2026

API Endpoint: api/session/event/participant/

API endpoints for endpoints for user Actions (e.g. build Building) in a testrun/impact Session.

Name Description
action_menu_set_active Set a Category active for a Stakeholder.
attribute_action_plan Apply an Attribute Action.
building_plan_construction Plan a new Building in the MAQUETTE map.
building_plan_demolish Plan the demolition of a Building in the MAQUETTE map.
building_plan_demolish_polygon Plan the demolition of a Buildings in the given Polygon in the MAQUETTE map.
building_plan_upgrade Plan the upgrade of Buildings in the given Polygon in the MAQUETTE map.
building_revert_polygon Revert Polygon to orginal CURRENT map situation.
event_bundle_apply_server_events Apply a bundle of events on the serverside for a particular Stakeholder.
map_buy_land Buy the land definied by the Polygon for given price.
map_levee Create a Levee with a given height and Area.
map_lower_land Lower land to create open water.
map_raise_land Raise land by one length unit.
map_sell_land Buy the land definied by the Polygon for given price.
measure_cancel_construction Cancel a Measure planned by an Stakeholder while in pre-construction phase.
measure_plan_construction Plan construction of a Measure by an Stakeholder that is not yet planned.
money_transfer_give Give money from one Stakeholder to another.
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 value of the Attribute.
net_cluster_set_state Set Timestate for all Net Loads of Net Cluster.
net_cluster_set_state_for_net_type Set Timestate for Net Loads of Net Cluster, based on Net Type.
net_cluster_set_states Set Timestate for all Net Loads of Net Cluster.
panel_answer Stakeholder has selected an Answer (Panel) in a Panel.
parametric_design_plan Parametric Design Plan
popup_answer Stakeholder Answer (Panel)s a Popup.
popup_answer_with_date Stakeholder Answer (Panel)s a Popup with an additional date.
restore_land Stakeholder restores land back to orginal state.
stakeholder_set_location Set the location of a Stakeholder in the 3D world.
zone_add_function_category Add a FunctionCategory that is allowed to be built within a Zone.
zone_remove_function_category Remove a FunctionCategory so it cannot be build within the Zone.
zones_set_categories Sets the allowed Building categories for specified Zones.

See also

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