make functions clear

This commit is contained in:
Bit Borealis 2023-08-16 08:08:06 +00:00
parent 8020d70cd7
commit 2f1dcd6b2a
Signed by: theotheroracle
GPG key ID: 2D816A2DCA6E5649

View file

@ -15,7 +15,8 @@ Assistant class definition:
Create an instance of Assistant called assistant Create an instance of Assistant called assistant
Toggle Saturn mode on/off: # Toggle Saturn mode on/off
define toggle_saturn_mode:
If Saturn mode is enabled: If Saturn mode is enabled:
Disable Saturn mode Disable Saturn mode
Set mode_status to "disabled" Set mode_status to "disabled"
@ -24,21 +25,24 @@ Toggle Saturn mode on/off:
Set mode_status to "enabled" Set mode_status to "enabled"
Call status_message("Saturn mode is now " + mode_status) Call status_message("Saturn mode is now " + mode_status)
Check if Saturn mode is enabled or disabled: # Check if Saturn mode is enabled or disabled
define check_saturn_mode_status:
If Saturn mode is enabled: If Saturn mode is enabled:
Set mode_status to "enabled" Set mode_status to "enabled"
Else: Else:
Set mode_status to "disabled" Set mode_status to "disabled"
Call status_message("Saturn mode is currently " + mode_status) Call status_message("Saturn mode is currently " + mode_status)
Handle user actions with optional prefix: # Handle user actions with optional prefix
define handle_action with action:
If Saturn mode is enabled: If Saturn mode is enabled:
Set prefix to "/me " Set prefix to "/me "
Else: Else:
Set prefix to "" Set prefix to nothing
Print prefix + action Print prefix + action
Handle help: # Display help information
display_help_information:
Set help_message to a multi-line string explaining available commands Set help_message to a multi-line string explaining available commands
Call display_message(help_message) Call display_message(help_message)
@ -48,10 +52,10 @@ Process user input:
Call handle_action(action) Call handle_action(action)
Else if user_input starts with "saturn": Else if user_input starts with "saturn":
If user_input is "saturn check": If user_input is "saturn check":
Call check_saturn_mode() Call check_saturn_mode_status() # Call the check_saturn_mode_status function
Else if user_input is "saturn switch": Else if user_input is "saturn switch":
Call toggle_saturn_mode() Call toggle_saturn_mode() # Call the toggle_saturn_mode function
Else if user_input is "saturn help": Else if user_input is "saturn help":
Call handle_help() Call display_help_information() # Call the display_help_information function
Else: Else:
Call assistant.reply(user_input) Call assistant.reply(user_input)