Build 12 [1.0b12]

build/CHANGELOG.DEV.md

@@ -1,3 +1,26 @@
+Build 12 [1.0b12]
+Started as a refactor, but I discovered that Entity controls were not functioning properly.
+ (and discovered that the mineraft entity controls actually are not as robust as ours).
+- Refactored all packet constants to a standard format:
+    CONSTANT = [PACKET, [PARSING]], where PACKET = 0xNN packet number and parsing
+     is a list of constants like [VARINT, BOOL, STRING].  Some packets already
+     followed this convention, but most simply defined packets like `PACKET_NAME = 0xNN`
+- Correct errors with new mcserver.py `_console_event` function not sending commands anywhere
+ except for the wrapper interface.
+- Corrected Entities config items listing old names (i.e. - 'Sheep' was changed to 'sheep' in 11.1)
+- Added internal wrapper event 'server.autoCompletes' to process (future) autocompletions.
+- Added optimization to make non-abortable events spur off in their own thread to prevent
+ delays to wrapper (and in proxy mode, proxy packet) processing.
+- Removed "player.runCommand" event from public API.  It is now private event.  Also
+ changed the behaviour to not be "abortable".. I.e. any command _will_ abort and get
+ processed directly by _either_ wrapper or the server.
+- All registered commands run on their own thread, so wrapper plugin commands
+ do not pause proxy!
+- All non-abortable events run as a deamon thread, allowing wrapper to continue
+ running while any event runs on a separate thread.
+- Made improvements to whitelist commands `online` and `offline`.
+
+
 Build 11 [1.0b11]
 - scrub out old packet.send methods that will be deprecated.
 - clean up keep-alives a little.

build/Wrapper.py.md5

@@ -1 +1 @@
-b4c48d6b9f98c70f49e062d8d9273f3e
+354911aaf7e35029c9af199b268b5174

build/build_script.py

@@ -265,6 +265,12 @@ def format_to_rst(data):
     when the event occurs.  The call back function must reference the correct
     return payload.
 
+    When a plugin calls an event which can be aborted, it is important that
+    your code not delay in completing.  The proxy packet processing is on
+    hold while your code decides what to do with the event.  If you take too 
+    long, the client could be disconnected!  This is an aggregate time of
+    all the plugins that call this event.
+
     :sample Plugin snippet:
 
         .. code:: python

build/buildinfo.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 # Do not edit this file to bump versions; it is built automatically
 
-__version__ = [1, 0, 0, 'beta', 11]
+__version__ = [1, 0, 0, 'beta', 12]
 __branch__ = 'dev'

build/version.json

@@ -6,9 +6,9 @@
         0, 
         0, 
         "beta", 
-        11
+        12
     ], 
     "build": 229, 
-    "release_time": 1519755280.663678, 
+    "release_time": 1520195736.894644, 
     "repotype": "dev"
 }

docs/Wrapper.py.md5

@@ -1 +1 @@
-b4c48d6b9f98c70f49e062d8d9273f3e
+354911aaf7e35029c9af199b268b5174

documentation/base.rst

@@ -192,7 +192,7 @@
 
 
 
--  callEvent(self, event, payload)
+-  callEvent(self, event, payload, abortable=False)
 
         Invokes the specific event. Payload is extra information
         relating to the event. Errors may occur if you don't specify

documentation/events.rst

@@ -6,6 +6,12 @@
     when the event occurs.  The call back function must reference the correct
     return payload.
 
+    When a plugin calls an event which can be aborted, it is important that
+    your code not delay in completing.  The proxy packet processing is on
+    hold while your code decides what to do with the event.  If you take too 
+    long, the client could be disconnected!  This is an aggregate time of
+    all the plugins that call this event.
+
     :sample Plugin snippet:
 
         .. code:: python
@@ -36,7 +42,8 @@
         When player logs into the java MC server.
 
     :Payload:
-        :"playername": player name
+        :"player": player object (if object available -could be False if not)
+        :"playername": user name of player (string)
 
     :Can be aborted/modified: No
 
@@ -49,13 +56,19 @@
 
     :Module: mcserver.py *(core/mcserver.py)*
 
-    :Description: player.logout
+    :Description:
+        When player logs out of the java MC server.
 
     :Payload:
-        :"player": self.getplayer(players_name)
+        :"player": player object (if object available -could be False if not)
+        :"playername": user name of player (string)
 
-    :Can be aborted/modified: 
+    :Can be aborted/modified: No - but This will pause long enough for you to deal with the playerobject.
 
+    :Comments:
+        All events in the core/mcserver.py group are collected
+        from the console output, do not require proxy mode, and
+        therefore, also, cannot be aborted.
 
 :Event: "server.stopped"
 
@@ -64,7 +77,8 @@
     :Description: server.stopped
 
     :Payload:
-        :"reason": reason
+        :"reason": reason}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -76,7 +90,8 @@
     :Description: server.starting
 
     :Payload:
-        :"reason": reason
+        :"reason": reason}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -88,7 +103,8 @@
     :Description: server.started
 
     :Payload:
-        :"reason": reason
+        :"reason": reason}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -100,7 +116,8 @@
     :Description: server.stopping
 
     :Payload:
-        :"reason": reason
+        :"reason": reason}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -113,7 +130,8 @@
 
     :Payload:
         :"state": state
-        :"reason": reason
+        :"reason": reason}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -130,7 +148,7 @@
         :"message": <str> type - what the player said in chat. ('hello everyone')
         :"original": The original line of text from the console ('<mcplayer> hello everyone`)
 
-    :Can be aborted/modified: 
+    :Can be aborted/modified: No
 
     :Comments:
         This event is triggered by console chat which has already been sent.
@@ -146,7 +164,8 @@
 
     :Payload:
         :"player": self.getplayer(name)
-        :"action": message
+        :"action": message}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -159,7 +178,8 @@
 
     :Payload:
         :"player": name
-        :"achievement": achievement
+        :"achievement": achievement}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -173,7 +193,8 @@
     :Payload:
         :"player": name
         :"message": message
-        :"original": original
+        :"original": original}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -187,7 +208,8 @@
     :Payload:
         :"player": self.getplayer(name)
         :"death": getargsafter(line_words
-         1)
+         1)}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -199,7 +221,8 @@
     :Description: server.lagged
 
     :Payload:
-        :"ticks": get_int(skipping_ticks)
+        :"ticks": get_int(skipping_ticks)}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -219,6 +242,21 @@
     :Comments:
         driven from console message "Teleported ___ to ....".
 
+**< Group 'api/base.py' >**
+
+:Event: "event"
+
+    :Module: base.py *(api/base.py)*
+
+    :Description: event
+
+    :Payload:
+         payload
+         abortable
+
+    :Can be aborted/modified: 
+
+
 **< Group 'wrapper' >**
 
 :Event: "timer.second"
@@ -228,7 +266,9 @@
     :Description:
         a timer that is called each second.
 
-    :Payload: None
+    :Payload:
+         None
+         abortable=False
 
     :Can be aborted/modified: No
 
@@ -241,7 +281,9 @@
         a timer that is called each 1/20th
           of a second, like a minecraft tick.
 
-    :Payload: None
+    :Payload:
+         None
+         abortable=False
 
     :Can be aborted/modified: No
 
@@ -259,7 +301,8 @@
 
     :Payload:
         :"nick": nick
-        :"channel": channel
+        :"channel": channel}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -272,7 +315,8 @@
 
     :Payload:
         :"nick": nick
-        :"channel": channel
+        :"channel": channel}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -286,7 +330,8 @@
     :Payload:
         :"nick": nick
         :"message": message
-        :"channel": None
+        :"channel": None}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -301,7 +346,8 @@
         :"nick": nick
         :"channel": channel
         :"action": getargsafter(message.split(" ")
-         1)[:-1]
+         1)[:-1]}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -315,7 +361,8 @@
     :Payload:
         :"nick": nick
         :"channel": channel
-        :"message": message
+        :"message": message}
+         abortable=False
 
     :Can be aborted/modified: 
 
@@ -364,32 +411,6 @@
         passing to server.  'chatmsg' accepts both raw string
         or a dictionary payload containing ["message"] item.
 
-:Event: "player.runCommand"
-
-    :Module: parse_sb.py *(client/parse_sb.py)*
-
-    :Description:
-        When a player runs a command. Do not use
-        for registering commands.
-
-    :Payload:
-        :"player": playerobject()
-        :"command": slash command (or whatever is set in wrapper's
-         config as the command cursor).
-        :"args": the remaining words/args
-
-    :Can be aborted/modified: Yes. Registered commands ARE already aborted since they do not get passed to the server.
-
-    :Comments:
-        Called AFTER player.rawMessage event (if rawMessage
-        does not reject it).  However, rawMessage could have
-        modified it before this point.
-
-        The best use of this event is a quick way to prevent a client from
-        passing certain commands or command arguments to the server.
-        rawMessage is better if you need something else (parsing or
-        filtering chat, for example).
-
 :Event: "player.dig"
 
     :Module: parse_sb.py *(client/parse_sb.py)*

documentation/helpers.rst

@@ -26,6 +26,12 @@ using 'self.api.helpers'
 
 
 
+-  config_write_from_dict(filename, filepath, dictionary)
+
+    Use a keyed dictionary and write a disk file with '='
+    lines (like server.properties).
+
+
 -  scrub_item_value(item)
 
     Takes a text item value and determines if it should be a boolean,

documentation/minecraft.rst

@@ -18,6 +18,24 @@
         fully booted or not.
 
 
+-  changeServerProps(self, config_item, new_value, reload_server=False)
+
+        *New feature starting in version 1.0*
+
+        Edits the server.properties file
+
+        :Args:
+            :item: item, like "online-mode"
+
+            :new_value: applicable value
+
+            :reload_server: True to restart the server.
+
+        Items are changed in the config, but a server restart is required to
+         make the changes persist.
+
+
+
 -  configWrapper(self, section, config_item, new_value, reload_file=False)
 
         *New feature starting in version 0.8.12*