<filename>plugins/custom_event_plugin.py
# Copyright (c) 2021-2022 <NAME>
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
from korth_spirit import Instance


class CustomEventPlugin:
    """
    Example of a custom event.
    """
    @property
    def on_event(self) -> str:
        """
        Event to listen for.
        """
        return 'version_requested'

    def __init__(self, instance: Instance) -> None:
        """
        Initialize the plugin.
        """
        self.instance = instance
    
    def handle_event(self) -> None:
        """
        Handle the event.

        Args:
            event (Event): The event.
        """
        self.instance.say(f"I am a creation of Johnathan Irvin [https://johnathanirvin.com]!")
        self.instance.say(f"The most up to date version of plugin bot is on github [https://github.com/Korth-Spirit/Plugin-Bot]!")
