Skip to content

The PySpigot Helper Module

Once Upon a Time...

Prior to PySpigot version 0.8.0, the pyspigot.py helper module was automatically copied into the python-libs folder. Since version 0.8.0, this no longer occurs, as the module is bundled into the JAR in such a way that makes it directly accessible (no copying required!).

If you still have the pyspigot.py helper module in your python-libs folder, it is safe to delete :)

PySpigot includes a helper module, pyspigot.py. This module is bundled into the PySpigot JAR file. This module is designed to make it easier to access PySpigot's managers from within your script. The code for this module is included below for your reference, along with some documentation for clarity.

Code

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
"""
A helper module for more easy access to PySpigot's managers.
"""
from dev.magicmq.pyspigot.bukkit import PySpigot
from dev.magicmq.pyspigot.manager.script import ScriptManager
from dev.magicmq.pyspigot.manager.script import GlobalVariables
from dev.magicmq.pyspigot.manager.listener import ListenerManager
from dev.magicmq.pyspigot.manager.command import CommandManager
from dev.magicmq.pyspigot.manager.task import TaskManager
from dev.magicmq.pyspigot.manager.config import ConfigManager
from dev.magicmq.pyspigot.manager.database import DatabaseManager
from dev.magicmq.pyspigot.manager.redis import RedisManager


def script_manager():
    """
    Get the script manager for loading, unloading, and reloading
    scripts.
    """
    return ScriptManager.get()


def global_variables():
    """
    Get the global variables manager for setting and getting global
    variables.
    """
    return GlobalVariables.get()


def listener_manager():
    """
    Get the listener manager for registering and unregistering
    event listeners.
    """
    return ListenerManager.get()


def command_manager():
    """
    Get the command manager for registering and unregistering
    commands.
    """
    return CommandManager.get()


def task_manager():
    """
    Get the task manager for scheduling and unscheduling tasks
    (synchronous and asynchronous).
    """
    return TaskManager.get()


def config_manager():
    """
    Get the config manager for writing to and reading from config
    files.
    """
    return ConfigManager.get()


def database_manager():
    """
    Get the database manager for connecting to and interacting
    with databases.
    """
    return DatabaseManager.get()


def redis_manager():
    """
    Get the redis manager for connecting to and interacting with
    redis servers.
    """
    return RedisManager.get()


def protocol_manager():
    """
    Get the protocol manager for working with ProtocolLib
    (registering/unregistering packet listeners, sending packets, etc.).

    Note: this function will return None if ProtocolLib is not available
    on the server.
    """
    if PySpigot.get().isProtocolLibAvailable():
        from dev.magicmq.pyspigot.bukkit.manager.protocol import ProtocolManager
        return ProtocolManager.get()
    else: return None


def placeholder_manager():
    """
    Get the placeholder manager for registering/unregistering
    PlaceholderAPI placeholders.

    Note: this function will return None if PlaceholderAPI is not available
    on the server.
    """
    if PySpigot.get().isPlaceholderApiAvailable():
        from dev.magicmq.pyspigot.bukkit.manager.placeholder import PlaceholderManager
        return PlaceholderManager.get()
    else: return None


# Convenience variables for ease of access

script = script_manager()
scripts = script_manager()
sm = script_manager()


global_vars = global_variables()
gv = global_variables()


listener = listener_manager()
listeners = listener_manager()
lm = listener_manager()
event = listener_manager()
events = listener_manager()
em = listener_manager()


command = command_manager()
commands = command_manager()
cm = command_manager()


scheduler = task_manager()
scm = task_manager()
tasks = task_manager()
tm = task_manager()


config = config_manager()
configs = config_manager()
com = config_manager()


database = database_manager()


redis = redis_manager()


protocol = protocol_manager()
protocol_lib = protocol_manager()
protocols = protocol_manager()
pm = protocol_manager()


placeholder = placeholder_manager()
placeholder_api = placeholder_manager()
placeholders = placeholder_manager()
plm = placeholder_manager()