Updated contrib example

evennia/contrib/gendersub.py

@@ -0,0 +1,133 @@
+"""
+Gendersub
+
+Griatch 2015
+
+This is a simple gender-aware Character class for allowing users to
+insert custom markers in their text to indicate gender-aware
+messaging. It relies on a modified msg() and is meant as an
+inspiration and starting point to how to do stuff like this.
+
+When in use, all messages being sent to the character will make use
+of the character's gender, for example the echo
+
+```
+char.msg("%s falls on {p face with a thud." % char.key)
+```
+
+will result in "Tom falls on his|her|its face with a thud" depending
+on the gender of the object being messaged. Default gender is
+"neutral".
+
+To use, have DefaultCharacter inherit from this, or change
+setting.DEFAULT_CHARACTER to point to this class.
+
+The `@gender` command needs to be added to the default cmdset
+before it becomes available.
+
+"""
+
+import re
+from evennia import DefaultCharacter
+from evennia import Command
+
+# gender maps
+
+_GENDER_PRONOUN_MAP = {"male": {"s": "he",
+                                "o": "him",
+                                "p": "his",
+                                "a": "his"},
+                       "female": {"s": "she",
+                                   "o": "her",
+                                   "p": "her",
+                                   "a": "hers"},
+                       "neutral": {"s": "it",
+                                    "o": "it",
+                                    "p": "its",
+                                    "a": "its"}}
+_RE_GENDER_PRONOUN = re.compile(r'({s|{S|{o|{O|{p|{P|{a|{A)')
+
+# in-game command for setting the gender
+
+class SetGender(Command):
+    """
+    Sets gender on yourself
+
+    Usage:
+      @gender male|female|neutral
+
+    """
+    key = "@gender"
+    alias = "@sex"
+    locks = "call:all()"
+
+    def func(self):
+        """
+        Implements the command.
+        """
+        caller = self.caller
+        arg = self.args.lower()
+        if not arg in ("male", "female", "neutral"):
+            caller.msg("Usage: @gender male|female|neutral")
+            return
+        caller.db.gender = arg
+        caller.msg("Your  gender was set to %s." % arg)
+
+
+# Gender-aware character class
+
+class GenderCharacter(DefaultCharacter):
+    """
+    This is a Character class aware of gender.
+
+    """
+
+    def at_object_creation(self):
+        """
+        Called once when the object is created.
+        """
+        super(GenderCharacter, self).at_object_creation()
+        self.db.gender = "neutral"
+
+    def _get_pronoun(self, regex_match):
+        """
+        Get pronoun from the pronoun marker in the text. This is used as
+        the callable for the re.sub function.
+
+        Args:
+            regex_match (MatchObject): the regular expression match.
+
+        Notes:
+            - `{s`, `{S`: Subjective form: he, she, it, He, She, It
+            - `{o`, `{O`: Objective form: him, her, it, Him, Her, It
+            - `{p`, `{P`: Possessive form: his, her, its, His, Her, Its
+            - `{a`, `{A`: Absolute Possessive form: his, hers, its, His, Hers, Its
+
+        """
+        typ = regex_match.group()[1] # "s", "O" etc
+        gender = self.attributes.get("gender", default="neutral")
+        gender = gender if gender in ("male", "female", "neutral") else "neutral"
+        pronoun = _GENDER_PRONOUN_MAP[gender][typ.lower()]
+        return pronoun.capitalize() if typ.isupper() else pronoun
+
+    def msg(self, text, from_obj=None, sessid=0, **kwargs):
+        """
+        Emits something to a session attached to the object.
+        Overloads the default msg() implementation to include
+        gender-aware markers in output.
+
+        Args:
+            text (str, optional): The message to send
+            from_obj (obj, optional): object that is sending. If
+                given, at_msg_send will be called
+            sessid (int or list, optional): sessid or list of
+                sessids to relay to, if any. If set, will
+                force send regardless of MULTISESSION_MODE.
+        Notes:
+            `at_msg_receive` will be called on this Object.
+            All extra kwargs will be passed on to the protocol.
+
+        """
+        # pre-process the text before continuing
+        text = _RE_GENDER_PRONOUN.sub(self._get_pronoun, text)
+        super(GenderCharacter, self).msg(text, from_obj=from_obj, sessid=sessid, **kwargs)