Skip to content

scenarios

Sam Vente edited this page Aug 6, 2024 · 1 revision

scenarios

``

Functions

Name Description
create_scenario
delete_scenario
edit_scenario
get_scenario
get_scenarios
run_scenario
save_scenario Save the scenario to the Database().

create_scenario

create_scenario(attrs)

delete_scenario

delete_scenario(name)

edit_scenario

edit_scenario(scenario)

get_scenario

get_scenario(name)

get_scenarios

get_scenarios()

run_scenario

run_scenario(name)

save_scenario

save_scenario(scenario)

Save the scenario to the Database().

Parameters

Name Type Description Default
scenario IScenario The scenario to save. required
database IDatabase The database to save the scenario to. required

Returns

Type Description
bool Whether the scenario was saved successfully.
str The error message if the scenario was not saved successfully.
Clone this wiki locally