mirror of
https://github.com/opus-tango/minecraft-server-discord-bot.git
synced 2026-03-20 03:55:20 +00:00
clean up function descriptions
This commit is contained in:
43
bot.py
43
bot.py
@@ -314,12 +314,7 @@ async def send_message(message):
|
|||||||
'''
|
'''
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def startserver(ctx, *args):
|
async def startserver(ctx, *args):
|
||||||
'''
|
''' [server name] : Start a server '''
|
||||||
Start a server
|
|
||||||
args:
|
|
||||||
servername: The name of the server
|
|
||||||
|
|
||||||
'''
|
|
||||||
global active_server, active_server_pipe_task
|
global active_server, active_server_pipe_task
|
||||||
# Validate and get the server name
|
# Validate and get the server name
|
||||||
if len(args) != 1:
|
if len(args) != 1:
|
||||||
@@ -402,10 +397,7 @@ async def startserver(ctx, *args):
|
|||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def stopserver(ctx):
|
async def stopserver(ctx):
|
||||||
'''
|
''' Stop the server by sending 'stop' to the server '''
|
||||||
Stop the server by sending 'stop' to the server
|
|
||||||
|
|
||||||
'''
|
|
||||||
global active_server
|
global active_server
|
||||||
if active_server is None:
|
if active_server is None:
|
||||||
await ctx.send("No server is currently active.")
|
await ctx.send("No server is currently active.")
|
||||||
@@ -414,12 +406,7 @@ async def stopserver(ctx):
|
|||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def command(ctx, *args):
|
async def command(ctx, *args):
|
||||||
'''
|
''' [command] : Send a command to the server '''
|
||||||
Send a command to the server
|
|
||||||
args:
|
|
||||||
command: The command to send
|
|
||||||
|
|
||||||
'''
|
|
||||||
global active_server
|
global active_server
|
||||||
# Check if the user is an admin
|
# Check if the user is an admin
|
||||||
if not ctx.author.guild_permissions.administrator:
|
if not ctx.author.guild_permissions.administrator:
|
||||||
@@ -432,10 +419,7 @@ async def command(ctx, *args):
|
|||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def list(ctx):
|
async def list(ctx):
|
||||||
'''
|
''' Lists currently running server and available servers '''
|
||||||
Lists currently running server and available servers
|
|
||||||
|
|
||||||
'''
|
|
||||||
global active_server
|
global active_server
|
||||||
# Load server data from json
|
# Load server data from json
|
||||||
servers = None
|
servers = None
|
||||||
@@ -473,10 +457,7 @@ async def list(ctx):
|
|||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def forcestopserver(ctx):
|
async def forcestopserver(ctx):
|
||||||
'''
|
''' Force stop the server by sending keyboard interrupt '''
|
||||||
Force stop the server by sending keyboard interrupt
|
|
||||||
|
|
||||||
'''
|
|
||||||
global active_server
|
global active_server
|
||||||
if not ctx.author.guild_permissions.administrator:
|
if not ctx.author.guild_permissions.administrator:
|
||||||
await ctx.send("You don't have permission to run this command.")
|
await ctx.send("You don't have permission to run this command.")
|
||||||
@@ -488,10 +469,7 @@ async def forcestopserver(ctx):
|
|||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def reloadregex(ctx):
|
async def reloadregex(ctx):
|
||||||
'''
|
''' Reload the regex for the server '''
|
||||||
Reload the regex for the server
|
|
||||||
|
|
||||||
'''
|
|
||||||
global regex_list, fprint_list
|
global regex_list, fprint_list
|
||||||
if not ctx.author.guild_permissions.administrator:
|
if not ctx.author.guild_permissions.administrator:
|
||||||
await ctx.send("You don't have permission to run this command.")
|
await ctx.send("You don't have permission to run this command.")
|
||||||
@@ -541,17 +519,12 @@ async def connecttoexistingpipe(ctx):
|
|||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def ping(ctx):
|
async def ping(ctx):
|
||||||
'''
|
''' Ping the bot '''
|
||||||
Ping the bot
|
|
||||||
|
|
||||||
'''
|
|
||||||
await ctx.send('Pong!')
|
await ctx.send('Pong!')
|
||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def botstop(ctx):
|
async def botstop(ctx):
|
||||||
'''
|
''' Stop the bot and clean up '''
|
||||||
Stop the bot and clean up
|
|
||||||
'''
|
|
||||||
global active_server, active_server_pipe_task
|
global active_server, active_server_pipe_task
|
||||||
|
|
||||||
if active_server is not None:
|
if active_server is not None:
|
||||||
|
|||||||
Reference in New Issue
Block a user