Skip to content

Commit

Permalink
update - updated the engine documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@OcelotWalrus
OcelotWalrus authored Dec 29, 2024
1 parent 4326b23 commit 79ae90a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/ENGINE_FUNCTIONS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The [`event_handling.py`](https://github.com/Dungeons-of-Kathallion/Bane-Of-Warg
| Name | Arguments | Description |
|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| event_triggering_checks() | `event_id`, `event`, `player`, `map`, `zone` | Return a boolean value that tells if the event id `event_id` can be triggered at the current player circumstances |
| trigger_event() | `event_id`, `event`, `player`, `mission`, `dialog`, `preferences`, `text_replacements_generic`, `drinks`, `item`, `enemy`, `npcs`, `start_player`, `lists`, `zone`, `mounts`, `start_time`, `map`, `save_file`, `map_location`, `player_damage_coefficient`, `previous_player`, `enemies_damage_coefficient` | Triggers event id `event_id` triggers |
| trigger_event() | `event_id`, `event`, `player`, `mission`, `dialog`, `preferences`, `text_replacements_generic`, `drinks`, `item`, `enemy`, `npcs`, `start_player`, `lists`, `zone`, `mounts`, `start_time`, `map`, `save_file`, `player_damage_coefficient`, `enemies_damage_coefficient`, `previous_player` | Triggers event id `event_id` triggers |

## item_handling.py

Expand Down Expand Up @@ -134,7 +134,7 @@ The [`mission_handling.py`](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wa
| mission_checks() | `mission_data`, `player`, `which_key` | Return a boolean value, to tell if a mission condition `which_key` is completed, from its data `mission_data` |
| execute_triggers() | `mission_data`, `player`, `which_key`, `dialog`, `preferences`, `text_replacements_generic`, `drinks`, `item`, `enemy`, `npcs`, `start_player`, `lists`, `zone`, `mission`, `mounts`, `start_time`, `map`, `save_file`, `player_damage_coefficient`, `enemies_damage_coefficient`, `previous_player` | Executes a mission trigger `which_key` from its data `mission_data` |
| offer_mission() | `mission_id`, `player`, `missions_data`, `dialog`, `preferences`, `text_replacements_generic`, `drinks`, `item`, `enemy`, `npcs`, `start_player`, `lists`, `zone`, `mission`, `mounts`, `start_time`, `map`, `save_file`, `player_damage_coefficient`, `enemies_damage_coefficient`, `previous_player` | Initiates the mission offering UI of mission id `mission_id` |
| mission_completing_checks() | `mission_id`, `missions_data`, `player`, `dialog`, `preferences`, `text_replacements_generic`, `drinks`, `item`, `enemy`, `npcs`, `start_player`, `lists`, `zone`, `mission`, `mounts`, `start_time`, `save_file`, `player_damage_coefficient` | Checks if mission id `mission_id` can be completed. If it can, mark it as completed and run its completing triggers if there are |
| mission_completing_checks() | `mission_id`, `missions_data`, `player`, `dialog`, `preferences`, `text_replacements_generic`, `drinks`, `item`, `enemy`, `npcs`, `start_player`, `lists`, `zone`, `mission`, `mounts`, `start_time`, `save_file`, `player_damage_coefficient`, `enemies_damage_coefficient`, `previous_player` | Checks if mission id `mission_id` can be completed. If it can, mark it as completed and run its completing triggers if there are |

## npc_handling.py

Expand Down

0 comments on commit 79ae90a

Please sign in to comment.