Api session event participant: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 6: | Line 6: | ||
!Description | !Description | ||
|- | |- | ||
|[[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]] | ||
|Apply an [[Attribute Action]]. | | Apply an [[Attribute Action]]. | ||
|- | |- | ||
|[[Api session event participant building plan construction|building_plan_construction]] | | [[Api session event participant building plan construction|building_plan_construction]] | ||
|Plan a new [[Building]] in the MAQUETTE map. | | Plan a new [[Building]] in the MAQUETTE map. | ||
|- | |- | ||
|[[Api session event participant building plan demolish|building_plan_demolish]] | | [[Api session event participant building plan demolish|building_plan_demolish]] | ||
|Plan the demolition of a [[Building]] in the MAQUETTE map. | | Plan the demolition of a [[Building]] in the MAQUETTE map. | ||
|- | |- | ||
|[[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]]s in the given [[ | | Plan the demolition of a [[Building]]s in the given [[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]]s in the given [[ | | Plan the upgrade of [[Building]]s in the given [[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 [[ | | Revert [[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]] | ||
|Apply a bundle of events on the serverside for a particular [[Stakeholder]]. | | Apply a bundle of events on the serverside for a particular [[Stakeholder]]. | ||
|- | |- | ||
|[[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 [[ | | Buy the land definied by the [[Polygon]] for given price. | ||
|- | |- | ||
|[[Api session event participant map levee|map_levee]] | | [[Api session event participant map levee|map_levee]] | ||
|Create a [[Levee]] with a given height and [[Area]]. | | Create a [[Levee]] with a given height and [[Area]]. | ||
|- | |- | ||
|[[Api session event participant map lower land|map_lower_land]] | | [[Api session event participant map lower land|map_lower_land]] | ||
|Lower land to create open water. | | Lower land to create open water. | ||
|- | |- | ||
|[[Api session event participant map raise land|map_raise_land]] | | [[Api session event participant map raise land|map_raise_land]] | ||
|Raise land by one length unit. | | Raise land by one length unit. | ||
|- | |- | ||
|[[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 [[ | | Buy the land definied by the [[Polygon]] for given price. | ||
|- | |- | ||
|[[Api session event participant measure cancel construction|measure_cancel_construction]] | | [[Api session event participant measure cancel construction|measure_cancel_construction]] | ||
|Cancel a [[Measure]] planned by an [[Stakeholder]] while in pre-construction phase. | | Cancel a [[Measure]] planned by an [[Stakeholder]] while in pre-construction phase. | ||
|- | |- | ||
|[[Api session event participant measure plan construction|measure_plan_construction]] | | [[Api session event participant measure plan construction|measure_plan_construction]] | ||
|Plan construction of a [[Measure]] by an [[Stakeholder]] that is not yet planned. | | Plan construction of a [[Measure]] by an [[Stakeholder]] that is not yet planned. | ||
|- | |- | ||
|[[Api session event participant money transfer give|money_transfer_give]] | | [[Api session event participant money transfer give|money_transfer_give]] | ||
|Give money from one [[Stakeholder]] to another. | | Give money from one [[Stakeholder]] to another. | ||
|- | |- | ||
|[[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]]s 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]]s 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]]s 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 (Panel)]] 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]] | ||
|[[Parametric Design]] Plan | | [[Parametric Design]] Plan | ||
|- | |- | ||
|[[Api session event participant popup answer|popup_answer]] | | [[Api session event participant popup answer|popup_answer]] | ||
|[[Stakeholder]] [[Answer (Panel)]]s 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]] [[Answer (Panel)]]s 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]] | ||
|[[Stakeholder]] restores land back to orginal state. | | [[Stakeholder]] restores land back to orginal state. | ||
|- | |- | ||
|[[Api session event participant stakeholder set location|stakeholder_set_location]] | | [[Api session event participant stakeholder set location|stakeholder_set_location]] | ||
|Set the location of a [[Stakeholder]] in the 3D world. | | Set the location of a [[Stakeholder]] in the 3D world. | ||
|- | |- | ||
|[[Api session event participant zone add function category|zone_add_function_category]] | | [[Api session event participant zone add function category|zone_add_function_category]] | ||
|Add a [[Function]][[Category]] that is allowed to be built within a [[Zone]]. | | Add a [[Function]][[Category]] that is allowed to be built within a [[Zone]]. | ||
|- | |- | ||
|[[Api session event participant zone remove function category|zone_remove_function_category]] | | [[Api session event participant zone remove function category|zone_remove_function_category]] | ||
|Remove a [[Function]][[Category]] so it cannot be build within the [[Zone]]. | | Remove a [[Function]][[Category]] so it cannot be build within the [[Zone]]. | ||
|- | |- | ||
|[[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]]s. | | Sets the allowed [[Building]] categories for specified [[Zone]]s. | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Latest revision as of 13:03, 19 June 2026
API Endpoint: api/session/event/participant/
API endpoints for endpoints for user Actions (e.g. build Building) in a testrun/impact Session.