diff --git a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Characters.md b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Characters.md index e69de29bb2..ee7b053338 100644 --- a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Characters.md +++ b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Characters.md @@ -0,0 +1,354 @@ +# Player Characters + +In the [previous lesson about rules and dice rolling](Beginner-Gutorial-Rules) we made some assumptions +about the "Player Character" entity: + +- It should store Abilities on itself as `character.strength`, `character.constitution` etc. +- It should have a `.heal(amount)` method. + +So we have some guidelines of how it should look! A Character is a database entity with values that +should be able to be changed over time. It makes sense to base it off Evennia's +[DefaultCharacter Typeclass](../../../Components/Typeclasses.md). The Character class is like a 'character sheet' in a tabletop +RPG, it will hold everything relevant to that PC. + +## Inheritance structure + +Player Characters (PCs) are not the only "living" things in our world. We also have _NPCs_ +(like shopkeepers and other friendlies) as well as _monsters_ (mobs) that can attack us. + +In code, there are a few ways we could structure this. If NPCs/monsters were just special cases of PCs, +we could use a class inheritance like this: + +```python +from evennia import DefaultCharacter + +class EvAdventureCharacter(DefaultCharacter): + # stuff + +class EvAdventureNPC(EvAdventureCharacter): + # more stuff + +class EvAdventureMob(EvAdventureNPC): + # more stuff +``` + +All code we put on the `Character` class would now be inherited to `NPC` and `Mob` automatically. + +However, in _Knave_, NPCs and particularly monsters are _not_ using the same rules as PCs - they are +simplified to use a Hit-Die (HD) concept. So while still character-like, NPCs should be separate from +PCs like this: + +```python +from evennia import DefaultCharacter + +class EvAdventureCharacter(DefaultCharacter): + # stuff + +class EvAdventureNPC(DefaultCharacter): + # separate stuff + +class EvAdventureMob(EvadventureNPC): + # more separate stuff +``` + +Nevertheless, there are some things that _should_ be common for all 'living things': + +- All can take damage. +- All can die. +- All can heal +- All can hold and lose coins +- All can loot their fallen foes. +- All can get looted when defeated. + +We don't want to code this separately for every class but we no longer have a common parent +class to put it on. So instead we'll use the concept of a _mixin_ class: + +```python +from evennia import DefaultCharacter + +class LivingMixin: + # stuff common for all living things + +class EvAdventureCharacter(LivingMixin, DefaultCharacter): + # stuff + +class EvAdventureNPC(LivingMixin, DefaultCharacter): + # stuff + +class EvAdventureMob(LivingMixin, EvadventureNPC): + # more stuff +``` + +```{sidebar} +In [evennia/contrib/tutorials/evadventure/characters.py](evennia.contrib.tutorials.evadventure.characters) +is an example of a character class structure. +``` +Above, the `LivingMixin` class cannot work on its own - it just 'patches' the other classes with some +extra functionality all living things should be able to do. This is an example of +_multiple inheritance_. It's useful to know about, but one should not over-do multiple inheritance +since it can also get confusing to follow the code. + +## Living mixin class + +> Create a new module `mygame/evadventure/characters.py` + +Let's get some useful common methods all living things should have in our game. + +```python +# in mygame/evadventure/characters.py + +from .rules import dice + +class LivingMixin: + + # makes it easy for mobs to know to attack PCs + is_pc = False + + def heal(self, hp): + """ + Heal hp amount of health, not allowing to exceed our max hp + + """ + damage = self.hp_max - self.hp + healed = min(damage, hp) + self.hp += healed + + self.msg("You heal for {healed} HP.") + + def at_pay(self, amount): + """When paying coins, make sure to never detract more than we have""" + amount = min(amount, self.coins) + self.coins -= amount + return amount + + def at_damage(self, damage, attacker=None): + """Called when attacked and taking damage.""" + self.hp -= damage + + def at_defeat(self): + """Called when defeated. By default this means death.""" + self.at_death() + + def at_death(self): + """Called when this thing dies.""" + # this will mean different things for different living things + pass + + def at_do_loot(self, looted): + """Called when looting another entity""" + looted.at_looted(self) + + def at_looted(self, looter): + """Called when looted by another entity""" + + # default to stealing some coins + max_steal = dice.roll("1d10") + stolen = self.at_pay(max_steal) + looter.coins += stolen + +``` +Most of these are empty since they will behave differently for characters and npcs. But having them +in the mixin means we can expect these methods to be available for all living things. + + +## Character class + +We will now start making the basic Character class, based on what we need from _Knave_. + +```python +# in mygame/evadventure/characters.py + +from evennia import DefaultCharacter, AttributeProperty +from .rules import dice + +class LivingMixin: + # ... + + +class EvAdventureCharacter(LivingMixin, DefaultCharacter): + """ + A character to use for EvAdventure. + """ + is_pc = True + + strength = AttributeProperty(1) + dexterity = AttributeProperty(1) + constitution = AttributeProperty(1) + intelligence = AttributeProperty(1) + wisdom = AttributeProperty(1) + charisma = AttributeProperty(1) + + hp = AttributeProperty(8) + hp_max = AttributeProperty(8) + + level = AttributeProperty(1) + xp = AttributeProperty(0) + coins = AttributeProperty(0) + + def at_defeat(self): + """Characters roll on the death table""" + if self.location.allow_death: + # this allow rooms to have non-lethal battles + dice.roll_death(self) + else: + self.location.msg_contents( + "$You() $conj(collapse) in a heap, alive but beaten.", + from_obj=self) + self.heal(self.hp_max) + + def at_death(self): + """We rolled 'dead' on the death table.""" + self.location.msg_contents( + "$You() collapse in a heap, embraced by death.", + from_obj=self) + # TODO - go back into chargen to make a new character! +``` + +We make an assumption about our rooms here - that they have a property `.allow_death`. We need +to make a note to actually add such a property to rooms later! + +In our `Character` class we implement all attributes we want to simulate from the _Knave_ ruleset. +The `AttributeProperty` is one way to add an Attribute in a field-like way; these will be accessible +on every character in several ways: + +- As `character.strength` +- As `character.db.strength` +- As `character.attributes.get("strength")` + +See [Attributes](../../../Components/Attributes.md) for seeing how Attributes work. + +Unlike in base _Knave_, we store `coins` as a separate Attribute rather than as items in the inventory, +this makes it easier to handle barter and trading later. + +We implement the Player Character versions of `at_defeat` and `at_death`. We also make use of `.heal()` +from the `LivingMixin` class. + +### Funcparser inlines + +This piece of code is worth some more explanation: + +```python +self.location.msg_contents( + "$You() $conj(collapse) in a heap, alive but beaten.", + from_obj=self) +``` + +Remember that `self` is the Character instance here. So `self.location.msg_contents` means "send a +message to everything inside my current location". In other words, send a message to everyone +in the same place as the character. + +The `$You() $conj(collapse)` are [Funcparser inlines](Funcparser). These are functions that execute +in the string. The resulting string may look different for different audiences. The `$You()` inline +function will use `from_obj` to figure out who 'you' are and either show your name or 'You'. +The `$conj()` (verb conjugator) will tweak the (English) verb to match. + +- You will see: `"You collapse in a heap, alive but beaten."` +- Others in the room will see: `"Thomas collapses in a heap, alive but beaten."` + +Note how `$conj()` chose `collapse/collapses` to make the sentences grammatically correct. + +### Backtracking + +We make our first use of the `rules.dice` roller to roll on the death table! As you may recall, in the +previous lesson, we didn't know just what to do when rolling 'dead' on this table. Now we know - we +should be calling `at_death` on the character. So let's add that where we had TODOs before: + +```python +# mygame/evadventure/rules.py + +class EvAdventureRollEngine: + + # ... + + def roll_death(self, character): + ability_name = self.roll_random_table("1d8", death_table) + + if ability_name == "dead": + # kill the character! + character.at_death() # <------ TODO no more + else: + # ... + + if current_ability < -10: + # kill the character! + character.at_death() # <------- TODO no more + else: + # ... +``` + + +## Unit Testing + +> Create a new module `mygame/evadventure/tests/test_characters.py` + +For testing, we just need to create a new EvAdventure character and check +that calling the methods on it doesn't error out. + +```python +# mygame/evadventure/tests/test_characters.py + +from evennia.utils import create +from evennia.utils.test_resources import BaseEvenniaTest + +from ..characters import EvAdventureCharacter + +class TestCharacters(BaseEvenniaTest): + def setUp(self): + super().setUp() + self.character = create.create_object(EvAdventureCharacter, key="testchar") + + def test_heal(self): + self.character.hp = 0 + self.character.hp_max = 8 + + self.character.heal(1) + self.assertEqual(self.character.hp, 1) + # make sure we can't heal more than max + self.character.heal(100) + self.assertEqual(self.character.hp, 8) + + def test_at_pay(self): + self.character.coins = 100 + + result = self.character.at_pay(60) + self.assertEqual(result, 60) + self.assertEqual(self.character.coins, 40) + + # can't get more coins than we have + result = self.character.at_pay(100) + self.assertEqual(result, 40) + self.assertEqual(self.character.coins, 0) + + # tests for other methods ... + +``` +If you followed the previous lessons, these tests should look familiar. Consider adding +tests for other methods as practice. Refer to previous lessons for details. + +For running the tests you do: + + evennia test --settings settings.py .evadventure.tests.test_character + +## Summary + + +With the `EvAdventureCharacter` class in place, we have a better understanding of how our PCs will look +like under _Knave_. + +For now, we only have bits and pieces and haven't been testing this code in-game. But if you want +you can swap yourself into `EvAdventureCharacter` right now. Log into your game and run +the command + + type self = evadventure.characters.EvAdventureCharacter + +If all went well, `ex self` will now show your typeclass as being `EvAdventureCharacter`. +Check out your strength with + + py self.strength = 3 + +```{important} +When doing `ex self` you will _not_ see all your Abilities listed yet. That's because +Attributes added with `AttributeProperty` are not available until they have been accessed at +least once. So once you set (or look at) `.strength` above, `strength` will show in `examine` from +then on. +``` diff --git a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Equipment.md b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Equipment.md new file mode 100644 index 0000000000..1ca872da88 --- /dev/null +++ b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Equipment.md @@ -0,0 +1,120 @@ +# Handling Equipment + +In _Knave_, you have a certain number of inventory "slots". The amount of slots is given by `CON + 10`. +All items (except coins) have a `size`, indicating how many slots it uses. You can't carry more items +than you have slot-space for. Also items wielded or worn count towards the slots. + +We still need to track what the character is using however: What weapon they have readied affects the damage +they can do. The shield, helmet and armor they use affects their defense. + +We have already set up the possible 'wear/wield locations' when we defined our Objects +[in the previous lesson](Beginner-Tutorial-Objects). This is what we have in `enums.py`: + +```python +# mygame/evadventure/enums.py + +# ... + +class WieldLocation(Enum): + + BACKPACK = "backpack" + WEAPON_HAND = "weapon_hand" + SHIELD_HAND = "shield_hand" + TWO_HANDS = "two_handed_weapons" + BODY = "body" # armor + HEAD = "head" # helmets +``` + +Basically, all the weapon/armor locations are exclusive - you can only have one item in each (or none). +The BACKPACK is special - it contains any number of items (up to the maximum slot usage). + +## EquipmentHandler + +> Create a new module `mygame/evadventure/equipment.py`. + +In default Evennia, everything you pick up will end up "inside" your character object (that is, have +you as its `.location`). This is called your _inventory_ and has no limit. We will keep 'moving items into us' +when we pick them up, but we will add more functionality using an _Equipment handler_. + +```{sidebar} +If you want to understand more about behind how Evennia uses handlers, there is a +[dedicated tutorial](Tutorial-Persistent-Handler) talking about the principle. +``` + +A handler is (for our purposes) an object that sits "on" another entity, containing functionality +for doing one specific thing (managing equipment, in our case). + +This is the start of our handler: + +```python +# in mygame/evadventure/equipment.py + +from .enums import WieldLocation + +class EquipmentHandler: + save_attribute = "inventory_slots" + + def __init__(self, obj): + # here obj is the character we store the handler on + self.obj = obj + self._load() + + def _load(self): + """Load our data from an Attribute on `self.obj`""" + self.slots = self.obj.attributes.get( + self.save_attribute, + category="inventory", + default={ + WieldLocation.WEAPON_HAND: None, + WieldLocation.SHIELD_HAND: None, + WieldLocation.TWO_HANDS: None, + WieldLocation.BODY: None, + WieldLocation.HEAD: None, + WieldLocation.BACKPACK: [] + } + ) + + def _save(self): + """Save our data back to the same Attribute""" + self.obj.attributes.add(self.save_attribute, self.slots, category="inventory") +``` + +This is a compact and functioning little handler. Before analyzing how it works, this is how +we will add it to the Character: + +```python +# mygame/evadventure/characters.py + +# ... + +from evennia.utils.utils import lazy_property +from .equipment import EquipmentHandler + +# ... + +class EvAdventureCharacter(LivingMixin, DefaultCharacter): + + # ... + + @lazy_property + def equipment(self): + return EquipmentHandler(self) +``` + +After reloading the server, the equipment-handler will now be accessible on the character as + + character.equipment + +The `@lazy_property` works such that it will not load the handler until it is first accessed. When that +happens, we start up the handler and feed it `self` (the Character itself). This is what enters `__init__` +as `.obj` in the `EquipmentHandler` code above. + +So we now have a handler on the character, and the handler has a back-reference to the character it sits +on. + +Since the handler itself is just a regular Python object, we need to use the `Character` to store +our data - our _Knave_ slots. We must save them to the database, because we want the server to remember +them even after reloading. + +Using `self.obj.attributes.add()` and `.get()` we save the data to the Character in a specially named +[Attribute](Attributes). Since we use a `category`, we are unlikely to collide with other Attributes. \ No newline at end of file diff --git a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Objects.md b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Objects.md index e69de29bb2..acc153f36d 100644 --- a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Objects.md +++ b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Objects.md @@ -0,0 +1,334 @@ +# In-game Objects and items + +In the previous lesson we established what a 'Character' is in our game. Before we continue +we also need to have a notion what an 'item' or 'object' is. + +Looking at _Knave_'s item lists, we can get some ideas of what we need to track: + +- `size` - this is how many 'slots' the item uses in the character's inventory. +- `value` - a base value if we want to sell or buy the item. +- `inventory_use_slot` - some items can be worn or wielded. For example, a helmet needs to be +worn on the head and a shield in the shield hand. Some items can't be used this way at all, but +only belong in the backpack. +- `obj_type` - Which 'type' of item this is. + + +## New Enums + +We added a few enumberations for Abilities back in the [Utilities tutorial](./Beginner-Tutorial-Utilities.md). +Before we continue, let's expand with enums for use-slots and object types. + +```python +# mygame/evadventure/enums.py + +# ... + +class WieldLocation(Enum): + + BACKPACK = "backpack" + WEAPON_HAND = "weapon_hand" + SHIELD_HAND = "shield_hand" + TWO_HANDS = "two_handed_weapons" + BODY = "body" # armor + HEAD = "head" # helmets + +class ObjType(Enum): + + WEAPON = "weapon" + ARMOR = "armor" + SHIELD = "shield" + HELMET = "helmet" + CONSUMABLE = "consumable" + GEAR = "gear" + MAGIC = "magic" + QUEST = "quest" + TREASURE = "treasure" +``` + +Once we have these enums, we will use them for referencing things. + +## The base object + +> Create a new module `mygame/evadventure/objects.py` + +```{sidebar} +[evennia/contrib/tutorials/evadventure/objects.py](evennia.contrib.tutorials.evadventure.objects) has +a full set of objects implemented. +``` +
+ +We will make a base `EvAdventureObject` class off Evennia's standard `DefaultObject`. We will then add +child classes to represent the relevant types: + +```python +# mygame/evadventure/objects.py + +from evennia import AttributeProperty, DefaultObject +from evennia.utils.utils import make_iter +from .utils import get_obj_stats +from .enums import WieldLocation, ObjType + + +class EvAdventureObject(DefaultObject): + """ + Base for all evadventure objects. + + """ + inventory_use_slot = WieldLocation.BACKPACK + size = AttributeProperty(1, autocreate=False) + value = AttributeProperty(0, autocreate=False) + + # this can be either a single type or a list of types (for objects able to be + # act as multiple). This is used to tag this object during creation. + obj_type = ObjType.GEAR + + def at_object_creation(self): + """Called when this object is first created. We convert the .obj_type + property to a database tag.""" + + for obj_type in make_iter(self.obj_type): + self.tags.add(self.obj_type.value, category="obj_type") + + def get_help(self): + """Get any help text for this item""" + return "No help for this item" +``` + +### Using Attributes or not + +In theory, `size` and `value` does not change and _could_ also be just set as a regular Python +property on the class: + +```python +class EvAdventureObject(DefaultObject): + inventory_use_slot = WieldLocation.BACKPACK + size = 1 + value = 0 +``` + +The problem with this is that if we want to make a new object of `size 3` and `value 20`, we have to +make a new class for it. We can't change it on the fly because the change would only be in memory and +be lost on next server reload. + +Because we use `AttributeProperties`, we can set `size` and `value` to whatever we like when we +create the object (or later), and the Attributes will remember our changes to that object indefinitely. + +To make this a little more efficient, we use `autocreate=False`. Normally when you create a +new object with defined `AttributeProperties`, a matching `Attribute` is immediately created at +the same time. So normally, the object would be created along with two Attributes `size` and `value`. +With `autocreate=False`, no Attribute will be created _unless the default is changed_. That is, as +long as your object has `size=1` no database `Attribute` will be created at all. This saves time and +resources when creating large number of objects. + +The drawback is that since no Attribute is created you can't refer to it +with `obj.db.size` or `obj.attributes.get("size")` _unless you change its default_. You also can't query +the database for all objects with `size=1`, since most objects would not yet have an in-database +`size` Attribute to search for. + +In our case, we'll only refer to these properties as `obj.size` etc, and have no need to find +all objects of a particular size. So we should be safe. + +### Creating tags in `at_object_creation` + +The `at_object_creation` is a method Evennia calls on every child of `DefaultObject` whenever it is +first created. + +We do a tricky thing here, converting our `.obj_type` to one or more [Tags](../../../Components/Tags.md). Tagging the +object like this means you can later efficiently find all objects of a given type (or combination of +types) with Evennia's search functions: + +```python + from .enums import ObjType + from evennia.utils import search + + # get all shields in the game + all_shields = search.search_object_by_tag(ObjType.SHIELD.value, category="obj_type") +``` + +We allow `.obj_type` to be given as a single value or a list of values. We use `make_iter` from the +evennia utility library to make sure we don't balk at either. This means you could have a Shield that +is also Magical, for example. + +## Other object types + +Some of the other object types are very simple so far. + +```python +# mygame/evadventure/objects.py + +from evennia import AttributeProperty, DefaultObject +from .enums import ObjType + +class EvAdventureObject(DefaultObject): + # ... + + +class EvAdventureQuestObject(EvAdventureObject): + """Quest objects should usually not be possible to sell or trade.""" + obj_type = ObjType.QUEST + +class EvAdventureTreasure(EvAdventureObject): + """Treasure is usually just for selling for coin""" + obj_type = ObjType.TREASURE + value = AttributeProperty(100, autocreate=False) + +``` + +## Consumables + +A 'consumable' is an item that has a certain number of 'uses'. Once fully consumed, it can't be used +anymore. An example would be a health potion. + + +```python +# mygame/evadventure/objects.py + +# ... + +class EvAdventureConsumable(EvAdventureObject): + """An item that can be used up""" + + obj_type = ObjType.CONSUMABLE + value = AttributeProperty(0.25, autocreate=False) + uses = AttributeProperty(1, autocreate=False) + + def at_pre_use(self, user, *args, **kwargs): + """Called before using. If returning False, abort use.""" + return uses > 0 + + def at_use(self, user, *args, **kwargs): + """Called when using the item""" + pass + + def at_post_use(self. user, *args, **kwargs): + """Called after using the item""" + # detract a usage, deleting the item if used up. + self.uses -= 1 + if self.uses <= 0: + user.msg(f"{self.key} was used up.") + self.delete() +``` + +What exactly each consumable does will vary - we will need to implement children of this class +later, overriding `at_use` with different effects. + +## Weapons + +All weapons need properties that describe how efficient they are in battle. + +```python +# mygame/evadventure/objects.py + +from .enums import WieldLocation, ObjType, Ability + +# ... + +class EvAdventureWeapon(EvAdventureObject): + """Base class for all weapons""" + + obj_type = ObjType.WEAPON + inventory_use_slot = AttributeProperty(WieldLocation.WEAPON_HAND, autocreate=False) + quality = AttributeProperty(3, autocreate=False) + + attack_type = AttibuteProperty(Ability.STR, autocreate=False) + defend_type = AttibuteProperty(Ability.ARMOR, autocreate=False) + + damage_roll = AttibuteProperty("1d6", autocreate=False) +``` + +The `quality` is something we need to track in _Knave_. When getting critical failures on attacks, +a weapon's quality will go down. When it reaches 0, it will break. + +The attack/defend type tracks how we resolve attacks with the weapon, like `roll + STR vs ARMOR + 10`. + +## Magic + +In _Knave_, anyone can use magic if they are wielding a rune stone (our name for spell books) in both +hands. You can only use a rune stone once per rest. So a rune stone is an example of a 'magical weapon' +that is also a 'consumable' of sorts. + + +```python +# mygame/evadventure/objects.py + +# ... +class EvAdventureConsumable(EvAdventureObject): + # ... + +class EvAdventureWeapon(EvAdventureObject): + # ... + +class EvAdventureRuneStone(EvAdventureWeapon, EvAdventureConsumable): + """Base for all magical rune stones""" + + obj_type = (ObjType.WEAPON, ObjType.MAGIC) + inventory_use_slot = WieldLocation.TWO_HANDS # always two hands for magic + quality = AttributeProperty(3, autocreate=False) + + attack_type = AttibuteProperty(Ability.INT, autocreate=False) + defend_type = AttibuteProperty(Ability.DEX, autocreate=False) + + damage_roll = AttibuteProperty("1d8", autocreate=False) + + def at_post_use(self, user, *args, **kwargs): + """Called after usage/spell was cast""" + self.uses -= 1 + # we don't delete the rune stone here, but + # it must be reset on next rest. + + def refresh(self): + """Refresh the rune stone (normally after rest)""" + self.uses = 1 +``` + +We make the rune stone a mix of weapon and consumable. Note that we don't have to add `.uses` +again, it's inherited from `EvAdventureConsumable` parent. The `at_pre_use` and `at_use` methods +are also inherited; we only override `at_post_use` since we don't want the runestone to be deleted +when it runs out of uses. + +We add a little convenience method `refresh` - we should call this when the character rests, to +make the runestone active again. + +Exactly what rune stones _do_ will be implemented in the `at_use` methods of subclasses to this +base class. Since magic in _Knave_ tends to be pretty custom, it makes sense that it will lead to a lot +of custom code. + + +## Armor + +Armor, shields and helmets increase the `ARMOR` stat of the character. In _Knave_, what is stored is the +defense value of the armor (values 11-20). We will instead store the 'armor bonus' (1-10). As we know, +defending is always `bonus + 10`, so the result will be the same - this means +we can use `Ability.ARMOR` as any other defensive ability without worrying about a special case. + +`` +```python +# mygame/evadventure/objects.py + +# ... + +class EvAdventureAmor(EvAdventureObject): + obj_type = ObjType.ARMOR + inventory_use_slot = WieldLocation.BODY + + armor = AttributeProperty(1, autocreate=False) + quality = AttributeProperty(3, autocreate=False) + + +class EvAdventureShield(EvAdventureArmor): + obj_type = ObjType.SHIELD + inventory_use_slot = WieldLocation.SHIELD_HAND + + +class EvAdventureHelmet(EvAdventureArmor): + obj_type = ObjType.HELMET + inventory_use_slot = WieldLocation.HEAD +``` + + + + + + + + diff --git a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.md b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.md index c3e96d5c99..f3746411c5 100644 --- a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.md +++ b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.md @@ -25,9 +25,11 @@ This is a big part. You'll be seeing a lot of code and there are plenty of lesso Take your time! If you followed the previous parts of this tutorial you will have some notions about Python and where to -find and make use of things in Evennia. We also have a good idea of the type of game we want. +find and make use of things in Evennia. We also have a good idea of the type of game we will +create. + Even if this is not the game-style you are interested in, following along will give you a lot -of experience with using Evennia. This be _really_ helpful for doing your own thing later. +of experience using Evennia and be really helpful for doing your own thing later! Fully coded examples of all code we make in this part can be found in the [evennia/contrib/tutorials/evadventure](evennia.contrib.tutorials.evadventure) package. @@ -39,27 +41,29 @@ Fully coded examples of all code we make in this part can be found in the Beginner-Tutorial-Utilities Beginner-Tutorial-Rules -Beginner-Tutorial-Chargen Beginner-Tutorial-Characters -Beginner-Tuturial-Objects -Beginner-Tutorial-Rooms -Beginner-Tutorial-NPCs -Beginner-Tutorial-Turnbased-Combat -Beginner-Tutorial-Quests -Beginner-Tutorial-Shops -Beginner-Tutorial-Dungeon -Beginner-Tutorial-Commands - - -## Table of Contents - -```{toctree} - -Beginner-Tutorial-Utilities -Beginner-Tutorial-Rules +Beginner-Tutorial-Objects +Beginner-Tutorial-Equipment +Beginner-Tutorial-Chargen +Beginner-Tutorial-Rooms +Beginner-Tutorial-NPCs +Beginner-Tutorial-Turnbased-Combat +Beginner-Tutorial-Quests +Beginner-Tutorial-Shops +Beginner-Tutorial-Dungeon +Beginner-Tutorial-Commands +``` + +## Table of Contents + +```{toctree} + +Beginner-Tutorial-Utilities +Beginner-Tutorial-Rules +Beginner-Tutorial-Characters +Beginner-Tutorial-Objects +Beginner-Tutorial-Equipment Beginner-Tutorial-Chargen -Beginner-Tutorial-Characters -Beginner-Tuturial-Objects Beginner-Tutorial-Rooms Beginner-Tutorial-NPCs Beginner-Tutorial-Turnbased-Combat diff --git a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Rules.md b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Rules.md index 6f8c1a3b5d..7ebbbc7539 100644 --- a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Rules.md +++ b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Rules.md @@ -361,30 +361,21 @@ class EvAdventureRollEngine: # ... - def heal(character, amount): - """ - Heal a certain amount of health, but not more - than character's `hp_max`. - - """ - - hp = character.hp - hp_max = character.hp_max - - damage = hp_max - hp - character.hp += min(damage, amount) - def heal_from_rest(self, character): """ A night's rest retains 1d8 + CON HP """ con_bonus = getattr(character, Ability.CON.value, 1) - self.heal(character, self.roll("1d8") + con_bonus) + character.heal(self.roll("1d8") + con_bonus) ``` -By splitting this into two methods, we get a free convenient `heal` method we can use for healing -also outside of sleeping. +We make another assumption here - that `character.heal()` is a thing. We tell this function how +much the character should heal, and it will do so, making sure to not heal more than its max +number of HPs + +> Knowing what is available on the character and what rule rolls we need is a bit of a chicken-and-egg +> problem. We will make sure to implement the matching _Character_ class next lesson. ### Rolling on a table @@ -568,11 +559,71 @@ We don't yet know what 'killing the character' technically means, so we mark thi return to it in a later lesson. We just know that we need to do _something_ here to kill off the character! +## Testing + +> Make a new module `mygame/evadventure/tests/test_rules.py` + +Testing the `rules` module will also showcase some very useful tools when testing. + +```python +# mygame/evadventure/tests/test_rules.py + +from unittest.mock import patch +from evennia.utils.test_resources import BaseEvenniaTest +from .. import rules + +class TestEvAdventureRuleEngine(BaseEvenniaTest): + + def setUp(self): + """Called before every test method""" + super().setUp() + self.roll_engine = rules.EvAdventureRollEngine() + + @patch("evadventure.rules.randint") + def test_roll(self, mock_randint): + mock_randint.return_value = 4 + self.assertEqual(self.roll_engine.roll("1d6", 4) + self.assertEqual(self.roll_engine.roll("2d6", 2 * 4) + + # test of the other rule methods below ... +``` + +As before, run the specific test with + + evennia test --settings settings.py .evadventure.tests.test_rules + +### Mocking and patching + +```{sidebar} +In [evennia/contrib/tutorials/evadventure/tests/test_rules.py](evennia.contrib.tutorials.evadventure.tests.test_rules) +has a complete example of rule testing. +``` +The `setUp` method is a special method of the testing class. It will be run before every +test method. We use `super().setUp()` to make sure the parent class' version of this method +always fire. Then we create a fresh `EvAdventureRollEngine` we can test with. + +In our test, we import `patch` from the `unittest.mock` library. This is a very useful tool for testing. +Normally the `randint` function we imported in `rules` will return a random value. That's very hard to +test for, since the value will be different every test. + +With `@patch` (this is called a _decorator_), we temporarily replace `rules.randint` with a 'mock' - a +dummy entity. This mock is passed into the testing method. We then take this `mock_randint` and set +`.return_value = 4` on it. + +Adding `return_value` to the mock means that every time this mock is called, it will return 4. For the +duration of the test we can now check with `self.assertEqual` that our `roll` method always returns a +result as-if the random result was 4. + +There are [many resources for understanding mock](https://realpython.com/python-mock-library/), refer to +them for further help. + +> The `EvAdventureRollEngine` have many methods to test. We leave this as an extra exercise! + ## Summary This concludes all the core rule mechanics of _Knave_ - the rules used during play. We noticed here that we are going to soon need to establish how our _Character_ actually stores data. So we will -address that next, before we get to the character generation itself. +address that next. diff --git a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Utilities.md b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Utilities.md index 2a99811c82..cbe83da468 100644 --- a/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Utilities.md +++ b/docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Utilities.md @@ -128,42 +128,9 @@ class Ability(Enum): ALLEGIANCE_FRIENDLY = "friendly" -class WieldLocation(Enum): - """ - Wield (or wear) locations. - - """ - - # wield/wear location - BACKPACK = "backpack" - WEAPON_HAND = "weapon_hand" - SHIELD_HAND = "shield_hand" - TWO_HANDS = "two_handed_weapons" - BODY = "body" # armor - HEAD = "head" # helmets - - -class ObjType(Enum): - """ - Object types. - - """ - - WEAPON = "weapon" - ARMOR = "armor" - SHIELD = "shield" - HELMET = "helmet" - CONSUMABLE = "consumable" - GEAR = "gear" - MAGIC = "magic" - QUEST = "quest" - TREASURE = "treasure" ``` -Here the `Ability` class holds basic properties of a character sheet, while `WieldLocation` tracks -equipment and where a character would wield and wear things - since _Knave_ has these, it makes sense -to track it. Finally we have a set of different `ObjType`s, for differentiate game items. These are -extracted by reading the _Knave_ object lists and figuring out how they should be categorized. +Here the `Ability` class holds basic properties of a character sheet. ## Utility module diff --git a/docs/source/Persistent-Handler.md b/docs/source/Howtos/Tutorial-Persistent-Handler.md similarity index 96% rename from docs/source/Persistent-Handler.md rename to docs/source/Howtos/Tutorial-Persistent-Handler.md index e95deabad0..cf9bd3cc6f 100644 --- a/docs/source/Persistent-Handler.md +++ b/docs/source/Howtos/Tutorial-Persistent-Handler.md @@ -1,10 +1,11 @@ +# Making a Persistent object Handler + A _handler_ is a convenient way to group functionality on an object. This allows you to logically group all actions related to that thing in one place. This tutorial expemplifies how to make your own handlers and make sure data you store in them survives a reload. For example, when you do `obj.attributes.get("key")` or `obj.tags.add('tagname')` you are evoking handlers stored as `.attributes` and `tags` on the `obj`. On these handlers are methods (`get()` and `add()` in this example). ## Base Handler example - Here is a base way to set up an on-object handler: ```python @@ -110,7 +111,7 @@ class QuestHandler: ``` -The handler is just a normal Python class and has no database-storage on its own. But it has a link to `.obj`, which is assumed to be a full typeclased entity, on which we can create persistent [Attributes](Components/Attributes.md) to store things however we like! +The handler is just a normal Python class and has no database-storage on its own. But it has a link to `.obj`, which is assumed to be a full typeclased entity, on which we can create persistent [Attributes](../Components/Attributes.md) to store things however we like! We make two helper methods `_load` and `_save` that handles local fetches and saves `storage` to an Attribute on the object. To avoid saving more than necessary, we have a property `do_save`. This we will set in `Quest` below. @@ -160,7 +161,7 @@ class Quest: The `Quest.__init__` now takes `obj` as argument, to match what we pass to it in `QuestHandler.add`. We want to monitor the changing of `current_step`, so we make it into a `property`. When we edit that value, we set the `do_save` flag on the handler, which means it will save the status to database once it has checked progress on all its quests. -The `__serialize__dbobjs__` and `__deserialize_dbobjs__` methods are needed because `Attributes` can't store 'hidden' database objects (the `Quest.obj` property. The methods help Evennia serialize/deserialize `Quest` propertly when the handler saves it. For more information, see [Storing Single objects](Components/Attributes.md#storing-single-objects) in the Attributes documentation. +The `__serialize__dbobjs__` and `__deserialize_dbobjs__` methods are needed because `Attributes` can't store 'hidden' database objects (the `Quest.obj` property. The methods help Evennia serialize/deserialize `Quest` propertly when the handler saves it. For more information, see [Storing Single objects](../Components/Attributes.md#storing-single-objects) in the Attributes documentation. ### Tying it all together diff --git a/docs/source/api/evennia-api.rst b/docs/source/api/evennia-api.rst new file mode 100644 index 0000000000..27caffe4e4 --- /dev/null +++ b/docs/source/api/evennia-api.rst @@ -0,0 +1,7 @@ +evennia +======= + +.. toctree:: + :maxdepth: 6 + + evennia diff --git a/docs/source/api/evennia.accounts.accounts.rst b/docs/source/api/evennia.accounts.accounts.rst new file mode 100644 index 0000000000..9be2b22d8d --- /dev/null +++ b/docs/source/api/evennia.accounts.accounts.rst @@ -0,0 +1,7 @@ +evennia.accounts.accounts module +================================ + +.. automodule:: evennia.accounts.accounts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.bots.rst b/docs/source/api/evennia.accounts.bots.rst new file mode 100644 index 0000000000..f6253d9855 --- /dev/null +++ b/docs/source/api/evennia.accounts.bots.rst @@ -0,0 +1,7 @@ +evennia.accounts.bots module +============================ + +.. automodule:: evennia.accounts.bots + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.manager.rst b/docs/source/api/evennia.accounts.manager.rst new file mode 100644 index 0000000000..4b69aae7ed --- /dev/null +++ b/docs/source/api/evennia.accounts.manager.rst @@ -0,0 +1,7 @@ +evennia.accounts.manager module +=============================== + +.. automodule:: evennia.accounts.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.models.rst b/docs/source/api/evennia.accounts.models.rst new file mode 100644 index 0000000000..5b4ad56484 --- /dev/null +++ b/docs/source/api/evennia.accounts.models.rst @@ -0,0 +1,7 @@ +evennia.accounts.models module +============================== + +.. automodule:: evennia.accounts.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.rst b/docs/source/api/evennia.accounts.rst new file mode 100644 index 0000000000..1c51f7e86a --- /dev/null +++ b/docs/source/api/evennia.accounts.rst @@ -0,0 +1,17 @@ +evennia.accounts package +======================== + +.. automodule:: evennia.accounts + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.accounts.accounts + evennia.accounts.bots + evennia.accounts.manager + evennia.accounts.models diff --git a/docs/source/api/evennia.commands.cmdhandler.rst b/docs/source/api/evennia.commands.cmdhandler.rst new file mode 100644 index 0000000000..d029279afe --- /dev/null +++ b/docs/source/api/evennia.commands.cmdhandler.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdhandler module +================================== + +.. automodule:: evennia.commands.cmdhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.cmdparser.rst b/docs/source/api/evennia.commands.cmdparser.rst new file mode 100644 index 0000000000..28f65c11d6 --- /dev/null +++ b/docs/source/api/evennia.commands.cmdparser.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdparser module +================================= + +.. automodule:: evennia.commands.cmdparser + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.cmdset.rst b/docs/source/api/evennia.commands.cmdset.rst new file mode 100644 index 0000000000..03a0b4ee7e --- /dev/null +++ b/docs/source/api/evennia.commands.cmdset.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdset module +============================== + +.. automodule:: evennia.commands.cmdset + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.cmdsethandler.rst b/docs/source/api/evennia.commands.cmdsethandler.rst new file mode 100644 index 0000000000..22e0c25c47 --- /dev/null +++ b/docs/source/api/evennia.commands.cmdsethandler.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdsethandler module +===================================== + +.. automodule:: evennia.commands.cmdsethandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.command.rst b/docs/source/api/evennia.commands.command.rst new file mode 100644 index 0000000000..2d792c1bef --- /dev/null +++ b/docs/source/api/evennia.commands.command.rst @@ -0,0 +1,7 @@ +evennia.commands.command module +=============================== + +.. automodule:: evennia.commands.command + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.account.rst b/docs/source/api/evennia.commands.default.account.rst new file mode 100644 index 0000000000..6a85919da2 --- /dev/null +++ b/docs/source/api/evennia.commands.default.account.rst @@ -0,0 +1,7 @@ +evennia.commands.default.account module +======================================= + +.. automodule:: evennia.commands.default.account + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.admin.rst b/docs/source/api/evennia.commands.default.admin.rst new file mode 100644 index 0000000000..5c6bebec11 --- /dev/null +++ b/docs/source/api/evennia.commands.default.admin.rst @@ -0,0 +1,7 @@ +evennia.commands.default.admin module +===================================== + +.. automodule:: evennia.commands.default.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.batchprocess.rst b/docs/source/api/evennia.commands.default.batchprocess.rst new file mode 100644 index 0000000000..7b8e819974 --- /dev/null +++ b/docs/source/api/evennia.commands.default.batchprocess.rst @@ -0,0 +1,7 @@ +evennia.commands.default.batchprocess module +============================================ + +.. automodule:: evennia.commands.default.batchprocess + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.building.rst b/docs/source/api/evennia.commands.default.building.rst new file mode 100644 index 0000000000..2f5f43cabb --- /dev/null +++ b/docs/source/api/evennia.commands.default.building.rst @@ -0,0 +1,7 @@ +evennia.commands.default.building module +======================================== + +.. automodule:: evennia.commands.default.building + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_account.rst b/docs/source/api/evennia.commands.default.cmdset_account.rst new file mode 100644 index 0000000000..c518041bc1 --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_account.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_account module +=============================================== + +.. automodule:: evennia.commands.default.cmdset_account + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_character.rst b/docs/source/api/evennia.commands.default.cmdset_character.rst new file mode 100644 index 0000000000..b4dff3406c --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_character.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_character module +================================================= + +.. automodule:: evennia.commands.default.cmdset_character + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_session.rst b/docs/source/api/evennia.commands.default.cmdset_session.rst new file mode 100644 index 0000000000..2f5ed3d177 --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_session.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_session module +=============================================== + +.. automodule:: evennia.commands.default.cmdset_session + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_unloggedin.rst b/docs/source/api/evennia.commands.default.cmdset_unloggedin.rst new file mode 100644 index 0000000000..4ccc5c52ac --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_unloggedin.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_unloggedin module +================================================== + +.. automodule:: evennia.commands.default.cmdset_unloggedin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.comms.rst b/docs/source/api/evennia.commands.default.comms.rst new file mode 100644 index 0000000000..9e6304398f --- /dev/null +++ b/docs/source/api/evennia.commands.default.comms.rst @@ -0,0 +1,7 @@ +evennia.commands.default.comms module +===================================== + +.. automodule:: evennia.commands.default.comms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.general.rst b/docs/source/api/evennia.commands.default.general.rst new file mode 100644 index 0000000000..3a992a34b0 --- /dev/null +++ b/docs/source/api/evennia.commands.default.general.rst @@ -0,0 +1,7 @@ +evennia.commands.default.general module +======================================= + +.. automodule:: evennia.commands.default.general + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.help.rst b/docs/source/api/evennia.commands.default.help.rst new file mode 100644 index 0000000000..475266e1ac --- /dev/null +++ b/docs/source/api/evennia.commands.default.help.rst @@ -0,0 +1,7 @@ +evennia.commands.default.help module +==================================== + +.. automodule:: evennia.commands.default.help + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.muxcommand.rst b/docs/source/api/evennia.commands.default.muxcommand.rst new file mode 100644 index 0000000000..bfe0f8055a --- /dev/null +++ b/docs/source/api/evennia.commands.default.muxcommand.rst @@ -0,0 +1,7 @@ +evennia.commands.default.muxcommand module +========================================== + +.. automodule:: evennia.commands.default.muxcommand + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.rst b/docs/source/api/evennia.commands.default.rst new file mode 100644 index 0000000000..605b697420 --- /dev/null +++ b/docs/source/api/evennia.commands.default.rst @@ -0,0 +1,29 @@ +evennia.commands.default package +================================ + +.. automodule:: evennia.commands.default + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.commands.default.account + evennia.commands.default.admin + evennia.commands.default.batchprocess + evennia.commands.default.building + evennia.commands.default.cmdset_account + evennia.commands.default.cmdset_character + evennia.commands.default.cmdset_session + evennia.commands.default.cmdset_unloggedin + evennia.commands.default.comms + evennia.commands.default.general + evennia.commands.default.help + evennia.commands.default.muxcommand + evennia.commands.default.syscommands + evennia.commands.default.system + evennia.commands.default.tests + evennia.commands.default.unloggedin diff --git a/docs/source/api/evennia.commands.default.syscommands.rst b/docs/source/api/evennia.commands.default.syscommands.rst new file mode 100644 index 0000000000..4d1ef77f6b --- /dev/null +++ b/docs/source/api/evennia.commands.default.syscommands.rst @@ -0,0 +1,7 @@ +evennia.commands.default.syscommands module +=========================================== + +.. automodule:: evennia.commands.default.syscommands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.system.rst b/docs/source/api/evennia.commands.default.system.rst new file mode 100644 index 0000000000..3fd11fed5c --- /dev/null +++ b/docs/source/api/evennia.commands.default.system.rst @@ -0,0 +1,7 @@ +evennia.commands.default.system module +====================================== + +.. automodule:: evennia.commands.default.system + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.tests.rst b/docs/source/api/evennia.commands.default.tests.rst new file mode 100644 index 0000000000..407cf01c81 --- /dev/null +++ b/docs/source/api/evennia.commands.default.tests.rst @@ -0,0 +1,7 @@ +evennia.commands.default.tests module +===================================== + +.. automodule:: evennia.commands.default.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.unloggedin.rst b/docs/source/api/evennia.commands.default.unloggedin.rst new file mode 100644 index 0000000000..c4b22e3123 --- /dev/null +++ b/docs/source/api/evennia.commands.default.unloggedin.rst @@ -0,0 +1,7 @@ +evennia.commands.default.unloggedin module +========================================== + +.. automodule:: evennia.commands.default.unloggedin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.rst b/docs/source/api/evennia.commands.rst new file mode 100644 index 0000000000..dd98fed278 --- /dev/null +++ b/docs/source/api/evennia.commands.rst @@ -0,0 +1,24 @@ +evennia.commands package +======================== + +.. automodule:: evennia.commands + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.commands.cmdhandler + evennia.commands.cmdparser + evennia.commands.cmdset + evennia.commands.cmdsethandler + evennia.commands.command + + +.. toctree:: + :maxdepth: 6 + + evennia.commands.default diff --git a/docs/source/api/evennia.comms.comms.rst b/docs/source/api/evennia.comms.comms.rst new file mode 100644 index 0000000000..a7157d5199 --- /dev/null +++ b/docs/source/api/evennia.comms.comms.rst @@ -0,0 +1,7 @@ +evennia.comms.comms module +========================== + +.. automodule:: evennia.comms.comms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.managers.rst b/docs/source/api/evennia.comms.managers.rst new file mode 100644 index 0000000000..3d20492f19 --- /dev/null +++ b/docs/source/api/evennia.comms.managers.rst @@ -0,0 +1,7 @@ +evennia.comms.managers module +============================= + +.. automodule:: evennia.comms.managers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.models.rst b/docs/source/api/evennia.comms.models.rst new file mode 100644 index 0000000000..4fd7dcc9d9 --- /dev/null +++ b/docs/source/api/evennia.comms.models.rst @@ -0,0 +1,7 @@ +evennia.comms.models module +=========================== + +.. automodule:: evennia.comms.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.rst b/docs/source/api/evennia.comms.rst new file mode 100644 index 0000000000..00ef04e075 --- /dev/null +++ b/docs/source/api/evennia.comms.rst @@ -0,0 +1,16 @@ +evennia.comms package +===================== + +.. automodule:: evennia.comms + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.comms.comms + evennia.comms.managers + evennia.comms.models diff --git a/docs/source/api/evennia.contrib.base_systems.awsstorage.aws_s3_cdn.rst b/docs/source/api/evennia.contrib.base_systems.awsstorage.aws_s3_cdn.rst new file mode 100644 index 0000000000..61046a67bb --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.awsstorage.aws_s3_cdn.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.awsstorage.aws\_s3\_cdn module +============================================================ + +.. automodule:: evennia.contrib.base_systems.awsstorage.aws_s3_cdn + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.awsstorage.rst b/docs/source/api/evennia.contrib.base_systems.awsstorage.rst new file mode 100644 index 0000000000..d1629083ca --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.awsstorage.rst @@ -0,0 +1,15 @@ +evennia.contrib.base\_systems.awsstorage package +================================================ + +.. automodule:: evennia.contrib.base_systems.awsstorage + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.awsstorage.aws_s3_cdn + evennia.contrib.base_systems.awsstorage.tests diff --git a/docs/source/api/evennia.contrib.base_systems.awsstorage.tests.rst b/docs/source/api/evennia.contrib.base_systems.awsstorage.tests.rst new file mode 100644 index 0000000000..30fb435288 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.awsstorage.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.awsstorage.tests module +===================================================== + +.. automodule:: evennia.contrib.base_systems.awsstorage.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.building_menu.building_menu.rst b/docs/source/api/evennia.contrib.base_systems.building_menu.building_menu.rst new file mode 100644 index 0000000000..da110c96e2 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.building_menu.building_menu.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.building\_menu.building\_menu module +================================================================== + +.. automodule:: evennia.contrib.base_systems.building_menu.building_menu + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.building_menu.rst b/docs/source/api/evennia.contrib.base_systems.building_menu.rst new file mode 100644 index 0000000000..8a840fef42 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.building_menu.rst @@ -0,0 +1,15 @@ +evennia.contrib.base\_systems.building\_menu package +==================================================== + +.. automodule:: evennia.contrib.base_systems.building_menu + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.building_menu.building_menu + evennia.contrib.base_systems.building_menu.tests diff --git a/docs/source/api/evennia.contrib.base_systems.building_menu.tests.rst b/docs/source/api/evennia.contrib.base_systems.building_menu.tests.rst new file mode 100644 index 0000000000..ef3171d87b --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.building_menu.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.building\_menu.tests module +========================================================= + +.. automodule:: evennia.contrib.base_systems.building_menu.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.color_markups.color_markups.rst b/docs/source/api/evennia.contrib.base_systems.color_markups.color_markups.rst new file mode 100644 index 0000000000..1c70e3754f --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.color_markups.color_markups.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.color\_markups.color\_markups module +================================================================== + +.. automodule:: evennia.contrib.base_systems.color_markups.color_markups + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.color_markups.rst b/docs/source/api/evennia.contrib.base_systems.color_markups.rst new file mode 100644 index 0000000000..ea28bd224f --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.color_markups.rst @@ -0,0 +1,15 @@ +evennia.contrib.base\_systems.color\_markups package +==================================================== + +.. automodule:: evennia.contrib.base_systems.color_markups + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.color_markups.color_markups + evennia.contrib.base_systems.color_markups.tests diff --git a/docs/source/api/evennia.contrib.base_systems.color_markups.tests.rst b/docs/source/api/evennia.contrib.base_systems.color_markups.tests.rst new file mode 100644 index 0000000000..f3f6c4c679 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.color_markups.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.color\_markups.tests module +========================================================= + +.. automodule:: evennia.contrib.base_systems.color_markups.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.components.component.rst b/docs/source/api/evennia.contrib.base_systems.components.component.rst new file mode 100644 index 0000000000..0fe68cbdac --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.components.component.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.components.component module +========================================================= + +.. automodule:: evennia.contrib.base_systems.components.component + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.components.dbfield.rst b/docs/source/api/evennia.contrib.base_systems.components.dbfield.rst new file mode 100644 index 0000000000..f80a709d4c --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.components.dbfield.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.components.dbfield module +======================================================= + +.. automodule:: evennia.contrib.base_systems.components.dbfield + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.components.holder.rst b/docs/source/api/evennia.contrib.base_systems.components.holder.rst new file mode 100644 index 0000000000..77b811ebfa --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.components.holder.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.components.holder module +====================================================== + +.. automodule:: evennia.contrib.base_systems.components.holder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.components.rst b/docs/source/api/evennia.contrib.base_systems.components.rst new file mode 100644 index 0000000000..d6ecc2b764 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.components.rst @@ -0,0 +1,18 @@ +evennia.contrib.base\_systems.components package +================================================ + +.. automodule:: evennia.contrib.base_systems.components + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.components.component + evennia.contrib.base_systems.components.dbfield + evennia.contrib.base_systems.components.holder + evennia.contrib.base_systems.components.signals + evennia.contrib.base_systems.components.tests diff --git a/docs/source/api/evennia.contrib.base_systems.components.signals.rst b/docs/source/api/evennia.contrib.base_systems.components.signals.rst new file mode 100644 index 0000000000..abc557bc7a --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.components.signals.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.components.signals module +======================================================= + +.. automodule:: evennia.contrib.base_systems.components.signals + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.components.tests.rst b/docs/source/api/evennia.contrib.base_systems.components.tests.rst new file mode 100644 index 0000000000..4c9afd89b4 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.components.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.components.tests module +===================================================== + +.. automodule:: evennia.contrib.base_systems.components.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.custom_gametime.custom_gametime.rst b/docs/source/api/evennia.contrib.base_systems.custom_gametime.custom_gametime.rst new file mode 100644 index 0000000000..dedce30d07 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.custom_gametime.custom_gametime.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.custom\_gametime.custom\_gametime module +====================================================================== + +.. automodule:: evennia.contrib.base_systems.custom_gametime.custom_gametime + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.custom_gametime.rst b/docs/source/api/evennia.contrib.base_systems.custom_gametime.rst new file mode 100644 index 0000000000..823aeed66e --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.custom_gametime.rst @@ -0,0 +1,15 @@ +evennia.contrib.base\_systems.custom\_gametime package +====================================================== + +.. automodule:: evennia.contrib.base_systems.custom_gametime + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.custom_gametime.custom_gametime + evennia.contrib.base_systems.custom_gametime.tests diff --git a/docs/source/api/evennia.contrib.base_systems.custom_gametime.tests.rst b/docs/source/api/evennia.contrib.base_systems.custom_gametime.tests.rst new file mode 100644 index 0000000000..a98267602b --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.custom_gametime.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.custom\_gametime.tests module +=========================================================== + +.. automodule:: evennia.contrib.base_systems.custom_gametime.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.email_login.connection_screens.rst b/docs/source/api/evennia.contrib.base_systems.email_login.connection_screens.rst new file mode 100644 index 0000000000..dacc9c3f45 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.email_login.connection_screens.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.email\_login.connection\_screens module +===================================================================== + +.. automodule:: evennia.contrib.base_systems.email_login.connection_screens + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.email_login.email_login.rst b/docs/source/api/evennia.contrib.base_systems.email_login.email_login.rst new file mode 100644 index 0000000000..1ff73c13e7 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.email_login.email_login.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.email\_login.email\_login module +============================================================== + +.. automodule:: evennia.contrib.base_systems.email_login.email_login + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.email_login.rst b/docs/source/api/evennia.contrib.base_systems.email_login.rst new file mode 100644 index 0000000000..f51e9c2c89 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.email_login.rst @@ -0,0 +1,16 @@ +evennia.contrib.base\_systems.email\_login package +================================================== + +.. automodule:: evennia.contrib.base_systems.email_login + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.email_login.connection_screens + evennia.contrib.base_systems.email_login.email_login + evennia.contrib.base_systems.email_login.tests diff --git a/docs/source/api/evennia.contrib.base_systems.email_login.tests.rst b/docs/source/api/evennia.contrib.base_systems.email_login.tests.rst new file mode 100644 index 0000000000..c99aea7965 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.email_login.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.email\_login.tests module +======================================================= + +.. automodule:: evennia.contrib.base_systems.email_login.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.callbackhandler.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.callbackhandler.rst new file mode 100644 index 0000000000..e36d4c5c3f --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.callbackhandler.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.ingame\_python.callbackhandler module +=================================================================== + +.. automodule:: evennia.contrib.base_systems.ingame_python.callbackhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.commands.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.commands.rst new file mode 100644 index 0000000000..c313631410 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.commands.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.ingame\_python.commands module +============================================================ + +.. automodule:: evennia.contrib.base_systems.ingame_python.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.eventfuncs.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.eventfuncs.rst new file mode 100644 index 0000000000..963fe527e6 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.eventfuncs.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.ingame\_python.eventfuncs module +============================================================== + +.. automodule:: evennia.contrib.base_systems.ingame_python.eventfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.rst new file mode 100644 index 0000000000..4985511010 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.rst @@ -0,0 +1,20 @@ +evennia.contrib.base\_systems.ingame\_python package +==================================================== + +.. automodule:: evennia.contrib.base_systems.ingame_python + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.ingame_python.callbackhandler + evennia.contrib.base_systems.ingame_python.commands + evennia.contrib.base_systems.ingame_python.eventfuncs + evennia.contrib.base_systems.ingame_python.scripts + evennia.contrib.base_systems.ingame_python.tests + evennia.contrib.base_systems.ingame_python.typeclasses + evennia.contrib.base_systems.ingame_python.utils diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.scripts.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.scripts.rst new file mode 100644 index 0000000000..11f3a8e453 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.scripts.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.ingame\_python.scripts module +=========================================================== + +.. automodule:: evennia.contrib.base_systems.ingame_python.scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.tests.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.tests.rst new file mode 100644 index 0000000000..f65977f106 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.ingame\_python.tests module +========================================================= + +.. automodule:: evennia.contrib.base_systems.ingame_python.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.typeclasses.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.typeclasses.rst new file mode 100644 index 0000000000..5ef3613860 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.typeclasses.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.ingame\_python.typeclasses module +=============================================================== + +.. automodule:: evennia.contrib.base_systems.ingame_python.typeclasses + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.ingame_python.utils.rst b/docs/source/api/evennia.contrib.base_systems.ingame_python.utils.rst new file mode 100644 index 0000000000..3d5bbb8230 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.ingame_python.utils.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.ingame\_python.utils module +========================================================= + +.. automodule:: evennia.contrib.base_systems.ingame_python.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.menu_login.connection_screens.rst b/docs/source/api/evennia.contrib.base_systems.menu_login.connection_screens.rst new file mode 100644 index 0000000000..9fc0eb1487 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.menu_login.connection_screens.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.menu\_login.connection\_screens module +==================================================================== + +.. automodule:: evennia.contrib.base_systems.menu_login.connection_screens + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.menu_login.menu_login.rst b/docs/source/api/evennia.contrib.base_systems.menu_login.menu_login.rst new file mode 100644 index 0000000000..24437a5aea --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.menu_login.menu_login.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.menu\_login.menu\_login module +============================================================ + +.. automodule:: evennia.contrib.base_systems.menu_login.menu_login + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.menu_login.rst b/docs/source/api/evennia.contrib.base_systems.menu_login.rst new file mode 100644 index 0000000000..3ca2a496ee --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.menu_login.rst @@ -0,0 +1,16 @@ +evennia.contrib.base\_systems.menu\_login package +================================================= + +.. automodule:: evennia.contrib.base_systems.menu_login + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.menu_login.connection_screens + evennia.contrib.base_systems.menu_login.menu_login + evennia.contrib.base_systems.menu_login.tests diff --git a/docs/source/api/evennia.contrib.base_systems.menu_login.tests.rst b/docs/source/api/evennia.contrib.base_systems.menu_login.tests.rst new file mode 100644 index 0000000000..c4ca10b447 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.menu_login.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.menu\_login.tests module +====================================================== + +.. automodule:: evennia.contrib.base_systems.menu_login.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.rst b/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.rst new file mode 100644 index 0000000000..c247a5ef6a --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.mux\_comms\_cmds.mux\_comms\_cmds module +====================================================================== + +.. automodule:: evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.rst b/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.rst new file mode 100644 index 0000000000..1b07bfbde7 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.rst @@ -0,0 +1,15 @@ +evennia.contrib.base\_systems.mux\_comms\_cmds package +====================================================== + +.. automodule:: evennia.contrib.base_systems.mux_comms_cmds + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds + evennia.contrib.base_systems.mux_comms_cmds.tests diff --git a/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.tests.rst b/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.tests.rst new file mode 100644 index 0000000000..6586189617 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.mux_comms_cmds.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.mux\_comms\_cmds.tests module +=========================================================== + +.. automodule:: evennia.contrib.base_systems.mux_comms_cmds.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.rst b/docs/source/api/evennia.contrib.base_systems.rst new file mode 100644 index 0000000000..7874657ea6 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.rst @@ -0,0 +1,22 @@ +evennia.contrib.base\_systems package +===================================== + +.. automodule:: evennia.contrib.base_systems + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.awsstorage + evennia.contrib.base_systems.building_menu + evennia.contrib.base_systems.color_markups + evennia.contrib.base_systems.components + evennia.contrib.base_systems.custom_gametime + evennia.contrib.base_systems.email_login + evennia.contrib.base_systems.ingame_python + evennia.contrib.base_systems.menu_login + evennia.contrib.base_systems.mux_comms_cmds + evennia.contrib.base_systems.unixcommand diff --git a/docs/source/api/evennia.contrib.base_systems.unixcommand.rst b/docs/source/api/evennia.contrib.base_systems.unixcommand.rst new file mode 100644 index 0000000000..8a1de9cf14 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.unixcommand.rst @@ -0,0 +1,15 @@ +evennia.contrib.base\_systems.unixcommand package +================================================= + +.. automodule:: evennia.contrib.base_systems.unixcommand + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems.unixcommand.tests + evennia.contrib.base_systems.unixcommand.unixcommand diff --git a/docs/source/api/evennia.contrib.base_systems.unixcommand.tests.rst b/docs/source/api/evennia.contrib.base_systems.unixcommand.tests.rst new file mode 100644 index 0000000000..0141185396 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.unixcommand.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.unixcommand.tests module +====================================================== + +.. automodule:: evennia.contrib.base_systems.unixcommand.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.base_systems.unixcommand.unixcommand.rst b/docs/source/api/evennia.contrib.base_systems.unixcommand.unixcommand.rst new file mode 100644 index 0000000000..cd892e6970 --- /dev/null +++ b/docs/source/api/evennia.contrib.base_systems.unixcommand.unixcommand.rst @@ -0,0 +1,7 @@ +evennia.contrib.base\_systems.unixcommand.unixcommand module +============================================================ + +.. automodule:: evennia.contrib.base_systems.unixcommand.unixcommand + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.commands.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.commands.rst new file mode 100644 index 0000000000..45a3c74cc4 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.commands.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.commands module +========================================================= + +.. automodule:: evennia.contrib.full_systems.evscaperoom.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.menu.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.menu.rst new file mode 100644 index 0000000000..ca37a3a627 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.menu.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.menu module +===================================================== + +.. automodule:: evennia.contrib.full_systems.evscaperoom.menu + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.objects.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.objects.rst new file mode 100644 index 0000000000..7d45c26d57 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.objects.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.objects module +======================================================== + +.. automodule:: evennia.contrib.full_systems.evscaperoom.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.room.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.room.rst new file mode 100644 index 0000000000..cfd6a1dfb7 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.room.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.room module +===================================================== + +.. automodule:: evennia.contrib.full_systems.evscaperoom.room + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.rst new file mode 100644 index 0000000000..e68e38fa8b --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.rst @@ -0,0 +1,21 @@ +evennia.contrib.full\_systems.evscaperoom package +================================================= + +.. automodule:: evennia.contrib.full_systems.evscaperoom + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.full_systems.evscaperoom.commands + evennia.contrib.full_systems.evscaperoom.menu + evennia.contrib.full_systems.evscaperoom.objects + evennia.contrib.full_systems.evscaperoom.room + evennia.contrib.full_systems.evscaperoom.scripts + evennia.contrib.full_systems.evscaperoom.state + evennia.contrib.full_systems.evscaperoom.tests + evennia.contrib.full_systems.evscaperoom.utils diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.scripts.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.scripts.rst new file mode 100644 index 0000000000..18e0e891e1 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.scripts.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.scripts module +======================================================== + +.. automodule:: evennia.contrib.full_systems.evscaperoom.scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.state.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.state.rst new file mode 100644 index 0000000000..ef411c3b0d --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.state.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.state module +====================================================== + +.. automodule:: evennia.contrib.full_systems.evscaperoom.state + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.tests.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.tests.rst new file mode 100644 index 0000000000..89549b3db8 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.tests module +====================================================== + +.. automodule:: evennia.contrib.full_systems.evscaperoom.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.evscaperoom.utils.rst b/docs/source/api/evennia.contrib.full_systems.evscaperoom.utils.rst new file mode 100644 index 0000000000..d1e389de85 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.evscaperoom.utils.rst @@ -0,0 +1,7 @@ +evennia.contrib.full\_systems.evscaperoom.utils module +====================================================== + +.. automodule:: evennia.contrib.full_systems.evscaperoom.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.full_systems.rst b/docs/source/api/evennia.contrib.full_systems.rst new file mode 100644 index 0000000000..e8c321d8b4 --- /dev/null +++ b/docs/source/api/evennia.contrib.full_systems.rst @@ -0,0 +1,13 @@ +evennia.contrib.full\_systems package +===================================== + +.. automodule:: evennia.contrib.full_systems + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.full_systems.evscaperoom diff --git a/docs/source/api/evennia.contrib.game_systems.barter.barter.rst b/docs/source/api/evennia.contrib.game_systems.barter.barter.rst new file mode 100644 index 0000000000..a5da1f27fe --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.barter.barter.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.barter.barter module +================================================== + +.. automodule:: evennia.contrib.game_systems.barter.barter + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.barter.rst b/docs/source/api/evennia.contrib.game_systems.barter.rst new file mode 100644 index 0000000000..04cb483bb9 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.barter.rst @@ -0,0 +1,15 @@ +evennia.contrib.game\_systems.barter package +============================================ + +.. automodule:: evennia.contrib.game_systems.barter + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.barter.barter + evennia.contrib.game_systems.barter.tests diff --git a/docs/source/api/evennia.contrib.game_systems.barter.tests.rst b/docs/source/api/evennia.contrib.game_systems.barter.tests.rst new file mode 100644 index 0000000000..70d565871a --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.barter.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.barter.tests module +================================================= + +.. automodule:: evennia.contrib.game_systems.barter.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.clothing.clothing.rst b/docs/source/api/evennia.contrib.game_systems.clothing.clothing.rst new file mode 100644 index 0000000000..2753e9a1cf --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.clothing.clothing.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.clothing.clothing module +====================================================== + +.. automodule:: evennia.contrib.game_systems.clothing.clothing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.clothing.rst b/docs/source/api/evennia.contrib.game_systems.clothing.rst new file mode 100644 index 0000000000..546dc1b71f --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.clothing.rst @@ -0,0 +1,15 @@ +evennia.contrib.game\_systems.clothing package +============================================== + +.. automodule:: evennia.contrib.game_systems.clothing + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.clothing.clothing + evennia.contrib.game_systems.clothing.tests diff --git a/docs/source/api/evennia.contrib.game_systems.clothing.tests.rst b/docs/source/api/evennia.contrib.game_systems.clothing.tests.rst new file mode 100644 index 0000000000..df2b16c377 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.clothing.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.clothing.tests module +=================================================== + +.. automodule:: evennia.contrib.game_systems.clothing.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.cooldowns.cooldowns.rst b/docs/source/api/evennia.contrib.game_systems.cooldowns.cooldowns.rst new file mode 100644 index 0000000000..86911974c1 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.cooldowns.cooldowns.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.cooldowns.cooldowns module +======================================================== + +.. automodule:: evennia.contrib.game_systems.cooldowns.cooldowns + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.cooldowns.rst b/docs/source/api/evennia.contrib.game_systems.cooldowns.rst new file mode 100644 index 0000000000..1489a76ccb --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.cooldowns.rst @@ -0,0 +1,15 @@ +evennia.contrib.game\_systems.cooldowns package +=============================================== + +.. automodule:: evennia.contrib.game_systems.cooldowns + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.cooldowns.cooldowns + evennia.contrib.game_systems.cooldowns.tests diff --git a/docs/source/api/evennia.contrib.game_systems.cooldowns.tests.rst b/docs/source/api/evennia.contrib.game_systems.cooldowns.tests.rst new file mode 100644 index 0000000000..3673da29a7 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.cooldowns.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.cooldowns.tests module +==================================================== + +.. automodule:: evennia.contrib.game_systems.cooldowns.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.crafting.crafting.rst b/docs/source/api/evennia.contrib.game_systems.crafting.crafting.rst new file mode 100644 index 0000000000..4771da56b0 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.crafting.crafting.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.crafting.crafting module +====================================================== + +.. automodule:: evennia.contrib.game_systems.crafting.crafting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.crafting.example_recipes.rst b/docs/source/api/evennia.contrib.game_systems.crafting.example_recipes.rst new file mode 100644 index 0000000000..4a29537b58 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.crafting.example_recipes.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.crafting.example\_recipes module +============================================================== + +.. automodule:: evennia.contrib.game_systems.crafting.example_recipes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.crafting.rst b/docs/source/api/evennia.contrib.game_systems.crafting.rst new file mode 100644 index 0000000000..a425dbd2a5 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.crafting.rst @@ -0,0 +1,16 @@ +evennia.contrib.game\_systems.crafting package +============================================== + +.. automodule:: evennia.contrib.game_systems.crafting + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.crafting.crafting + evennia.contrib.game_systems.crafting.example_recipes + evennia.contrib.game_systems.crafting.tests diff --git a/docs/source/api/evennia.contrib.game_systems.crafting.tests.rst b/docs/source/api/evennia.contrib.game_systems.crafting.tests.rst new file mode 100644 index 0000000000..0e0f67864d --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.crafting.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.crafting.tests module +=================================================== + +.. automodule:: evennia.contrib.game_systems.crafting.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.gendersub.gendersub.rst b/docs/source/api/evennia.contrib.game_systems.gendersub.gendersub.rst new file mode 100644 index 0000000000..b5711e8f08 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.gendersub.gendersub.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.gendersub.gendersub module +======================================================== + +.. automodule:: evennia.contrib.game_systems.gendersub.gendersub + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.gendersub.rst b/docs/source/api/evennia.contrib.game_systems.gendersub.rst new file mode 100644 index 0000000000..9012d6781b --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.gendersub.rst @@ -0,0 +1,15 @@ +evennia.contrib.game\_systems.gendersub package +=============================================== + +.. automodule:: evennia.contrib.game_systems.gendersub + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.gendersub.gendersub + evennia.contrib.game_systems.gendersub.tests diff --git a/docs/source/api/evennia.contrib.game_systems.gendersub.tests.rst b/docs/source/api/evennia.contrib.game_systems.gendersub.tests.rst new file mode 100644 index 0000000000..fa35254118 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.gendersub.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.gendersub.tests module +==================================================== + +.. automodule:: evennia.contrib.game_systems.gendersub.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.mail.mail.rst b/docs/source/api/evennia.contrib.game_systems.mail.mail.rst new file mode 100644 index 0000000000..1cd1eb8b0c --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.mail.mail.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.mail.mail module +============================================== + +.. automodule:: evennia.contrib.game_systems.mail.mail + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.mail.rst b/docs/source/api/evennia.contrib.game_systems.mail.rst new file mode 100644 index 0000000000..c96aaef865 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.mail.rst @@ -0,0 +1,15 @@ +evennia.contrib.game\_systems.mail package +========================================== + +.. automodule:: evennia.contrib.game_systems.mail + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.mail.mail + evennia.contrib.game_systems.mail.tests diff --git a/docs/source/api/evennia.contrib.game_systems.mail.tests.rst b/docs/source/api/evennia.contrib.game_systems.mail.tests.rst new file mode 100644 index 0000000000..28679f1994 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.mail.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.mail.tests module +=============================================== + +.. automodule:: evennia.contrib.game_systems.mail.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.multidescer.multidescer.rst b/docs/source/api/evennia.contrib.game_systems.multidescer.multidescer.rst new file mode 100644 index 0000000000..7ec51bac20 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.multidescer.multidescer.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.multidescer.multidescer module +============================================================ + +.. automodule:: evennia.contrib.game_systems.multidescer.multidescer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.multidescer.rst b/docs/source/api/evennia.contrib.game_systems.multidescer.rst new file mode 100644 index 0000000000..a00318ea21 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.multidescer.rst @@ -0,0 +1,15 @@ +evennia.contrib.game\_systems.multidescer package +================================================= + +.. automodule:: evennia.contrib.game_systems.multidescer + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.multidescer.multidescer + evennia.contrib.game_systems.multidescer.tests diff --git a/docs/source/api/evennia.contrib.game_systems.multidescer.tests.rst b/docs/source/api/evennia.contrib.game_systems.multidescer.tests.rst new file mode 100644 index 0000000000..5d30372a1e --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.multidescer.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.multidescer.tests module +====================================================== + +.. automodule:: evennia.contrib.game_systems.multidescer.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.puzzles.puzzles.rst b/docs/source/api/evennia.contrib.game_systems.puzzles.puzzles.rst new file mode 100644 index 0000000000..d53c8df3b5 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.puzzles.puzzles.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.puzzles.puzzles module +==================================================== + +.. automodule:: evennia.contrib.game_systems.puzzles.puzzles + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.puzzles.rst b/docs/source/api/evennia.contrib.game_systems.puzzles.rst new file mode 100644 index 0000000000..b3fca6bb32 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.puzzles.rst @@ -0,0 +1,15 @@ +evennia.contrib.game\_systems.puzzles package +============================================= + +.. automodule:: evennia.contrib.game_systems.puzzles + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.puzzles.puzzles + evennia.contrib.game_systems.puzzles.tests diff --git a/docs/source/api/evennia.contrib.game_systems.puzzles.tests.rst b/docs/source/api/evennia.contrib.game_systems.puzzles.tests.rst new file mode 100644 index 0000000000..968695094e --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.puzzles.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.puzzles.tests module +================================================== + +.. automodule:: evennia.contrib.game_systems.puzzles.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.rst b/docs/source/api/evennia.contrib.game_systems.rst new file mode 100644 index 0000000000..d84b996c3f --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.rst @@ -0,0 +1,21 @@ +evennia.contrib.game\_systems package +===================================== + +.. automodule:: evennia.contrib.game_systems + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.barter + evennia.contrib.game_systems.clothing + evennia.contrib.game_systems.cooldowns + evennia.contrib.game_systems.crafting + evennia.contrib.game_systems.gendersub + evennia.contrib.game_systems.mail + evennia.contrib.game_systems.multidescer + evennia.contrib.game_systems.puzzles + evennia.contrib.game_systems.turnbattle diff --git a/docs/source/api/evennia.contrib.game_systems.turnbattle.rst b/docs/source/api/evennia.contrib.game_systems.turnbattle.rst new file mode 100644 index 0000000000..b3e0bd3f4f --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.turnbattle.rst @@ -0,0 +1,19 @@ +evennia.contrib.game\_systems.turnbattle package +================================================ + +.. automodule:: evennia.contrib.game_systems.turnbattle + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.game_systems.turnbattle.tb_basic + evennia.contrib.game_systems.turnbattle.tb_equip + evennia.contrib.game_systems.turnbattle.tb_items + evennia.contrib.game_systems.turnbattle.tb_magic + evennia.contrib.game_systems.turnbattle.tb_range + evennia.contrib.game_systems.turnbattle.tests diff --git a/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_basic.rst b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_basic.rst new file mode 100644 index 0000000000..75b085fa8d --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_basic.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.turnbattle.tb\_basic module +========================================================= + +.. automodule:: evennia.contrib.game_systems.turnbattle.tb_basic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_equip.rst b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_equip.rst new file mode 100644 index 0000000000..b9e48e1282 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_equip.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.turnbattle.tb\_equip module +========================================================= + +.. automodule:: evennia.contrib.game_systems.turnbattle.tb_equip + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_items.rst b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_items.rst new file mode 100644 index 0000000000..ef3ae5e1c4 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_items.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.turnbattle.tb\_items module +========================================================= + +.. automodule:: evennia.contrib.game_systems.turnbattle.tb_items + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_magic.rst b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_magic.rst new file mode 100644 index 0000000000..4e9f746e84 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_magic.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.turnbattle.tb\_magic module +========================================================= + +.. automodule:: evennia.contrib.game_systems.turnbattle.tb_magic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_range.rst b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_range.rst new file mode 100644 index 0000000000..a960b46d10 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.turnbattle.tb_range.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.turnbattle.tb\_range module +========================================================= + +.. automodule:: evennia.contrib.game_systems.turnbattle.tb_range + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.game_systems.turnbattle.tests.rst b/docs/source/api/evennia.contrib.game_systems.turnbattle.tests.rst new file mode 100644 index 0000000000..86cc3f0a07 --- /dev/null +++ b/docs/source/api/evennia.contrib.game_systems.turnbattle.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.game\_systems.turnbattle.tests module +===================================================== + +.. automodule:: evennia.contrib.game_systems.turnbattle.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.extended_room.extended_room.rst b/docs/source/api/evennia.contrib.grid.extended_room.extended_room.rst new file mode 100644 index 0000000000..8dd90e644a --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.extended_room.extended_room.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.extended\_room.extended\_room module +========================================================= + +.. automodule:: evennia.contrib.grid.extended_room.extended_room + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.extended_room.rst b/docs/source/api/evennia.contrib.grid.extended_room.rst new file mode 100644 index 0000000000..ce6f6a8de1 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.extended_room.rst @@ -0,0 +1,15 @@ +evennia.contrib.grid.extended\_room package +=========================================== + +.. automodule:: evennia.contrib.grid.extended_room + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.extended_room.extended_room + evennia.contrib.grid.extended_room.tests diff --git a/docs/source/api/evennia.contrib.grid.extended_room.tests.rst b/docs/source/api/evennia.contrib.grid.extended_room.tests.rst new file mode 100644 index 0000000000..8cd23ae52e --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.extended_room.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.extended\_room.tests module +================================================ + +.. automodule:: evennia.contrib.grid.extended_room.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.mapbuilder.mapbuilder.rst b/docs/source/api/evennia.contrib.grid.mapbuilder.mapbuilder.rst new file mode 100644 index 0000000000..fb1471eec7 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.mapbuilder.mapbuilder.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.mapbuilder.mapbuilder module +================================================= + +.. automodule:: evennia.contrib.grid.mapbuilder.mapbuilder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.mapbuilder.rst b/docs/source/api/evennia.contrib.grid.mapbuilder.rst new file mode 100644 index 0000000000..a810761e44 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.mapbuilder.rst @@ -0,0 +1,15 @@ +evennia.contrib.grid.mapbuilder package +======================================= + +.. automodule:: evennia.contrib.grid.mapbuilder + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.mapbuilder.mapbuilder + evennia.contrib.grid.mapbuilder.tests diff --git a/docs/source/api/evennia.contrib.grid.mapbuilder.tests.rst b/docs/source/api/evennia.contrib.grid.mapbuilder.tests.rst new file mode 100644 index 0000000000..51f2b3ddd8 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.mapbuilder.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.mapbuilder.tests module +============================================ + +.. automodule:: evennia.contrib.grid.mapbuilder.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.rst b/docs/source/api/evennia.contrib.grid.rst new file mode 100644 index 0000000000..5dcb1410d3 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.rst @@ -0,0 +1,18 @@ +evennia.contrib.grid package +============================ + +.. automodule:: evennia.contrib.grid + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.extended_room + evennia.contrib.grid.mapbuilder + evennia.contrib.grid.simpledoor + evennia.contrib.grid.slow_exit + evennia.contrib.grid.wilderness + evennia.contrib.grid.xyzgrid diff --git a/docs/source/api/evennia.contrib.grid.simpledoor.rst b/docs/source/api/evennia.contrib.grid.simpledoor.rst new file mode 100644 index 0000000000..d2417a996e --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.simpledoor.rst @@ -0,0 +1,15 @@ +evennia.contrib.grid.simpledoor package +======================================= + +.. automodule:: evennia.contrib.grid.simpledoor + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.simpledoor.simpledoor + evennia.contrib.grid.simpledoor.tests diff --git a/docs/source/api/evennia.contrib.grid.simpledoor.simpledoor.rst b/docs/source/api/evennia.contrib.grid.simpledoor.simpledoor.rst new file mode 100644 index 0000000000..e77ff0f80b --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.simpledoor.simpledoor.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.simpledoor.simpledoor module +================================================= + +.. automodule:: evennia.contrib.grid.simpledoor.simpledoor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.simpledoor.tests.rst b/docs/source/api/evennia.contrib.grid.simpledoor.tests.rst new file mode 100644 index 0000000000..39cca9dd6b --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.simpledoor.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.simpledoor.tests module +============================================ + +.. automodule:: evennia.contrib.grid.simpledoor.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.slow_exit.rst b/docs/source/api/evennia.contrib.grid.slow_exit.rst new file mode 100644 index 0000000000..f87494bd1e --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.slow_exit.rst @@ -0,0 +1,15 @@ +evennia.contrib.grid.slow\_exit package +======================================= + +.. automodule:: evennia.contrib.grid.slow_exit + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.slow_exit.slow_exit + evennia.contrib.grid.slow_exit.tests diff --git a/docs/source/api/evennia.contrib.grid.slow_exit.slow_exit.rst b/docs/source/api/evennia.contrib.grid.slow_exit.slow_exit.rst new file mode 100644 index 0000000000..5fc04f05cc --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.slow_exit.slow_exit.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.slow\_exit.slow\_exit module +================================================= + +.. automodule:: evennia.contrib.grid.slow_exit.slow_exit + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.slow_exit.tests.rst b/docs/source/api/evennia.contrib.grid.slow_exit.tests.rst new file mode 100644 index 0000000000..9ac2966cfd --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.slow_exit.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.slow\_exit.tests module +============================================ + +.. automodule:: evennia.contrib.grid.slow_exit.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.wilderness.rst b/docs/source/api/evennia.contrib.grid.wilderness.rst new file mode 100644 index 0000000000..ff22335b66 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.wilderness.rst @@ -0,0 +1,15 @@ +evennia.contrib.grid.wilderness package +======================================= + +.. automodule:: evennia.contrib.grid.wilderness + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.wilderness.tests + evennia.contrib.grid.wilderness.wilderness diff --git a/docs/source/api/evennia.contrib.grid.wilderness.tests.rst b/docs/source/api/evennia.contrib.grid.wilderness.tests.rst new file mode 100644 index 0000000000..b2e7a66c1c --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.wilderness.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.wilderness.tests module +============================================ + +.. automodule:: evennia.contrib.grid.wilderness.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.wilderness.wilderness.rst b/docs/source/api/evennia.contrib.grid.wilderness.wilderness.rst new file mode 100644 index 0000000000..1c2a53cb22 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.wilderness.wilderness.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.wilderness.wilderness module +================================================= + +.. automodule:: evennia.contrib.grid.wilderness.wilderness + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.commands.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.commands.rst new file mode 100644 index 0000000000..1c29c88845 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.commands.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.commands module +============================================ + +.. automodule:: evennia.contrib.grid.xyzgrid.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.example.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.example.rst new file mode 100644 index 0000000000..fd2671fe53 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.example.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.example module +=========================================== + +.. automodule:: evennia.contrib.grid.xyzgrid.example + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.launchcmd.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.launchcmd.rst new file mode 100644 index 0000000000..cb8e660fe0 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.launchcmd.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.launchcmd module +============================================= + +.. automodule:: evennia.contrib.grid.xyzgrid.launchcmd + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.prototypes.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.prototypes.rst new file mode 100644 index 0000000000..d7c08c3413 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.prototypes.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.prototypes module +============================================== + +.. automodule:: evennia.contrib.grid.xyzgrid.prototypes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.rst new file mode 100644 index 0000000000..8da0e720f7 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.rst @@ -0,0 +1,23 @@ +evennia.contrib.grid.xyzgrid package +==================================== + +.. automodule:: evennia.contrib.grid.xyzgrid + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.grid.xyzgrid.commands + evennia.contrib.grid.xyzgrid.example + evennia.contrib.grid.xyzgrid.launchcmd + evennia.contrib.grid.xyzgrid.prototypes + evennia.contrib.grid.xyzgrid.tests + evennia.contrib.grid.xyzgrid.utils + evennia.contrib.grid.xyzgrid.xymap + evennia.contrib.grid.xyzgrid.xymap_legend + evennia.contrib.grid.xyzgrid.xyzgrid + evennia.contrib.grid.xyzgrid.xyzroom diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.tests.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.tests.rst new file mode 100644 index 0000000000..182bc3d674 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.tests module +========================================= + +.. automodule:: evennia.contrib.grid.xyzgrid.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.utils.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.utils.rst new file mode 100644 index 0000000000..2560076037 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.utils.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.utils module +========================================= + +.. automodule:: evennia.contrib.grid.xyzgrid.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.xymap.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.xymap.rst new file mode 100644 index 0000000000..3ffdbe2d74 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.xymap.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.xymap module +========================================= + +.. automodule:: evennia.contrib.grid.xyzgrid.xymap + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.xymap_legend.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.xymap_legend.rst new file mode 100644 index 0000000000..beabfa713d --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.xymap_legend.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.xymap\_legend module +================================================= + +.. automodule:: evennia.contrib.grid.xyzgrid.xymap_legend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.xyzgrid.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.xyzgrid.rst new file mode 100644 index 0000000000..eedf1020f1 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.xyzgrid.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.xyzgrid module +=========================================== + +.. automodule:: evennia.contrib.grid.xyzgrid.xyzgrid + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.grid.xyzgrid.xyzroom.rst b/docs/source/api/evennia.contrib.grid.xyzgrid.xyzroom.rst new file mode 100644 index 0000000000..816c1073d3 --- /dev/null +++ b/docs/source/api/evennia.contrib.grid.xyzgrid.xyzroom.rst @@ -0,0 +1,7 @@ +evennia.contrib.grid.xyzgrid.xyzroom module +=========================================== + +.. automodule:: evennia.contrib.grid.xyzgrid.xyzroom + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.buffs.buff.rst b/docs/source/api/evennia.contrib.rpg.buffs.buff.rst new file mode 100644 index 0000000000..aea46662c9 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.buffs.buff.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.buffs.buff module +===================================== + +.. automodule:: evennia.contrib.rpg.buffs.buff + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.buffs.rst b/docs/source/api/evennia.contrib.rpg.buffs.rst new file mode 100644 index 0000000000..701c236892 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.buffs.rst @@ -0,0 +1,16 @@ +evennia.contrib.rpg.buffs package +================================= + +.. automodule:: evennia.contrib.rpg.buffs + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.rpg.buffs.buff + evennia.contrib.rpg.buffs.samplebuffs + evennia.contrib.rpg.buffs.tests diff --git a/docs/source/api/evennia.contrib.rpg.buffs.samplebuffs.rst b/docs/source/api/evennia.contrib.rpg.buffs.samplebuffs.rst new file mode 100644 index 0000000000..b3cd14a4b3 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.buffs.samplebuffs.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.buffs.samplebuffs module +============================================ + +.. automodule:: evennia.contrib.rpg.buffs.samplebuffs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.buffs.tests.rst b/docs/source/api/evennia.contrib.rpg.buffs.tests.rst new file mode 100644 index 0000000000..1d6174500c --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.buffs.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.buffs.tests module +====================================== + +.. automodule:: evennia.contrib.rpg.buffs.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.dice.dice.rst b/docs/source/api/evennia.contrib.rpg.dice.dice.rst new file mode 100644 index 0000000000..907ed2eb3f --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.dice.dice.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.dice.dice module +==================================== + +.. automodule:: evennia.contrib.rpg.dice.dice + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.dice.rst b/docs/source/api/evennia.contrib.rpg.dice.rst new file mode 100644 index 0000000000..e97b14e4aa --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.dice.rst @@ -0,0 +1,15 @@ +evennia.contrib.rpg.dice package +================================ + +.. automodule:: evennia.contrib.rpg.dice + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.rpg.dice.dice + evennia.contrib.rpg.dice.tests diff --git a/docs/source/api/evennia.contrib.rpg.dice.tests.rst b/docs/source/api/evennia.contrib.rpg.dice.tests.rst new file mode 100644 index 0000000000..2a310141c3 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.dice.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.dice.tests module +===================================== + +.. automodule:: evennia.contrib.rpg.dice.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.health_bar.health_bar.rst b/docs/source/api/evennia.contrib.rpg.health_bar.health_bar.rst new file mode 100644 index 0000000000..91c7a57be9 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.health_bar.health_bar.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.health\_bar.health\_bar module +================================================== + +.. automodule:: evennia.contrib.rpg.health_bar.health_bar + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.health_bar.rst b/docs/source/api/evennia.contrib.rpg.health_bar.rst new file mode 100644 index 0000000000..799605f789 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.health_bar.rst @@ -0,0 +1,15 @@ +evennia.contrib.rpg.health\_bar package +======================================= + +.. automodule:: evennia.contrib.rpg.health_bar + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.rpg.health_bar.health_bar + evennia.contrib.rpg.health_bar.tests diff --git a/docs/source/api/evennia.contrib.rpg.health_bar.tests.rst b/docs/source/api/evennia.contrib.rpg.health_bar.tests.rst new file mode 100644 index 0000000000..e6cf8f63a9 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.health_bar.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.health\_bar.tests module +============================================ + +.. automodule:: evennia.contrib.rpg.health_bar.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.rpsystem.rplanguage.rst b/docs/source/api/evennia.contrib.rpg.rpsystem.rplanguage.rst new file mode 100644 index 0000000000..22756ef7ce --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.rpsystem.rplanguage.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.rpsystem.rplanguage module +============================================== + +.. automodule:: evennia.contrib.rpg.rpsystem.rplanguage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.rpsystem.rpsystem.rst b/docs/source/api/evennia.contrib.rpg.rpsystem.rpsystem.rst new file mode 100644 index 0000000000..2a3b870976 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.rpsystem.rpsystem.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.rpsystem.rpsystem module +============================================ + +.. automodule:: evennia.contrib.rpg.rpsystem.rpsystem + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.rpsystem.rst b/docs/source/api/evennia.contrib.rpg.rpsystem.rst new file mode 100644 index 0000000000..0e6d60f88e --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.rpsystem.rst @@ -0,0 +1,16 @@ +evennia.contrib.rpg.rpsystem package +==================================== + +.. automodule:: evennia.contrib.rpg.rpsystem + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.rpg.rpsystem.rplanguage + evennia.contrib.rpg.rpsystem.rpsystem + evennia.contrib.rpg.rpsystem.tests diff --git a/docs/source/api/evennia.contrib.rpg.rpsystem.tests.rst b/docs/source/api/evennia.contrib.rpg.rpsystem.tests.rst new file mode 100644 index 0000000000..f48cd2c9a5 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.rpsystem.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.rpsystem.tests module +========================================= + +.. automodule:: evennia.contrib.rpg.rpsystem.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.rst b/docs/source/api/evennia.contrib.rpg.rst new file mode 100644 index 0000000000..cf7f5d961d --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.rst @@ -0,0 +1,17 @@ +evennia.contrib.rpg package +=========================== + +.. automodule:: evennia.contrib.rpg + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.rpg.buffs + evennia.contrib.rpg.dice + evennia.contrib.rpg.health_bar + evennia.contrib.rpg.rpsystem + evennia.contrib.rpg.traits diff --git a/docs/source/api/evennia.contrib.rpg.traits.rst b/docs/source/api/evennia.contrib.rpg.traits.rst new file mode 100644 index 0000000000..9664bca8f9 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.traits.rst @@ -0,0 +1,15 @@ +evennia.contrib.rpg.traits package +================================== + +.. automodule:: evennia.contrib.rpg.traits + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.rpg.traits.tests + evennia.contrib.rpg.traits.traits diff --git a/docs/source/api/evennia.contrib.rpg.traits.tests.rst b/docs/source/api/evennia.contrib.rpg.traits.tests.rst new file mode 100644 index 0000000000..0a90321dd5 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.traits.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.traits.tests module +======================================= + +.. automodule:: evennia.contrib.rpg.traits.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpg.traits.traits.rst b/docs/source/api/evennia.contrib.rpg.traits.traits.rst new file mode 100644 index 0000000000..b51d825c37 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpg.traits.traits.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpg.traits.traits module +======================================== + +.. automodule:: evennia.contrib.rpg.traits.traits + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rst b/docs/source/api/evennia.contrib.rst new file mode 100644 index 0000000000..a7fb965905 --- /dev/null +++ b/docs/source/api/evennia.contrib.rst @@ -0,0 +1,19 @@ +evennia.contrib package +======================= + +.. automodule:: evennia.contrib + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.base_systems + evennia.contrib.full_systems + evennia.contrib.game_systems + evennia.contrib.grid + evennia.contrib.rpg + evennia.contrib.tutorials + evennia.contrib.utils diff --git a/docs/source/api/evennia.contrib.tutorials.batchprocessor.example_batch_code.rst b/docs/source/api/evennia.contrib.tutorials.batchprocessor.example_batch_code.rst new file mode 100644 index 0000000000..2a909aff2e --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.batchprocessor.example_batch_code.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.batchprocessor.example\_batch\_code module +==================================================================== + +.. automodule:: evennia.contrib.tutorials.batchprocessor.example_batch_code + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.batchprocessor.rst b/docs/source/api/evennia.contrib.tutorials.batchprocessor.rst new file mode 100644 index 0000000000..61939ca5f1 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.batchprocessor.rst @@ -0,0 +1,14 @@ +evennia.contrib.tutorials.batchprocessor package +================================================ + +.. automodule:: evennia.contrib.tutorials.batchprocessor + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.batchprocessor.example_batch_code diff --git a/docs/source/api/evennia.contrib.tutorials.bodyfunctions.bodyfunctions.rst b/docs/source/api/evennia.contrib.tutorials.bodyfunctions.bodyfunctions.rst new file mode 100644 index 0000000000..e539bf7e08 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.bodyfunctions.bodyfunctions.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.bodyfunctions.bodyfunctions module +============================================================ + +.. automodule:: evennia.contrib.tutorials.bodyfunctions.bodyfunctions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.bodyfunctions.rst b/docs/source/api/evennia.contrib.tutorials.bodyfunctions.rst new file mode 100644 index 0000000000..43c1726d19 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.bodyfunctions.rst @@ -0,0 +1,15 @@ +evennia.contrib.tutorials.bodyfunctions package +=============================================== + +.. automodule:: evennia.contrib.tutorials.bodyfunctions + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.bodyfunctions.bodyfunctions + evennia.contrib.tutorials.bodyfunctions.tests diff --git a/docs/source/api/evennia.contrib.tutorials.bodyfunctions.tests.rst b/docs/source/api/evennia.contrib.tutorials.bodyfunctions.tests.rst new file mode 100644 index 0000000000..0fe4b768bf --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.bodyfunctions.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.bodyfunctions.tests module +==================================================== + +.. automodule:: evennia.contrib.tutorials.bodyfunctions.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.build_techdemo.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.build_techdemo.rst new file mode 100644 index 0000000000..162911450a --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.build_techdemo.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.build\_techdemo module +============================================================ + +.. automodule:: evennia.contrib.tutorials.evadventure.build_techdemo + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.build_world.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.build_world.rst new file mode 100644 index 0000000000..2a22e04974 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.build_world.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.build\_world module +========================================================= + +.. automodule:: evennia.contrib.tutorials.evadventure.build_world + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.characters.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.characters.rst new file mode 100644 index 0000000000..7981266660 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.characters.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.characters module +======================================================= + +.. automodule:: evennia.contrib.tutorials.evadventure.characters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.combat_turnbased.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.combat_turnbased.rst new file mode 100644 index 0000000000..f057acb4f1 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.combat_turnbased.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.combat\_turnbased module +============================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.combat_turnbased + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.commands.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.commands.rst new file mode 100644 index 0000000000..dbd6e31069 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.commands.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.commands module +===================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.dungeon.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.dungeon.rst new file mode 100644 index 0000000000..e9df318075 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.dungeon.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.dungeon module +==================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.dungeon + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.enums.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.enums.rst new file mode 100644 index 0000000000..63b6c852ac --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.enums.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.enums module +================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.enums + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.equipment.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.equipment.rst new file mode 100644 index 0000000000..9e3280927e --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.equipment.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.equipment module +====================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.equipment + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.npcs.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.npcs.rst new file mode 100644 index 0000000000..49d29135b9 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.npcs.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.npcs module +================================================= + +.. automodule:: evennia.contrib.tutorials.evadventure.npcs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.objects.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.objects.rst new file mode 100644 index 0000000000..4852550680 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.objects.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.objects module +==================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.quests.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.quests.rst new file mode 100644 index 0000000000..560a68212d --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.quests.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.quests module +=================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.quests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.random_tables.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.random_tables.rst new file mode 100644 index 0000000000..e6a3eba526 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.random_tables.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.random\_tables module +=========================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.random_tables + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.rooms.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.rooms.rst new file mode 100644 index 0000000000..b4851491c6 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.rooms.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.rooms module +================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.rooms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.rst new file mode 100644 index 0000000000..7f4925a71a --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.rst @@ -0,0 +1,35 @@ +evennia.contrib.tutorials.evadventure package +============================================= + +.. automodule:: evennia.contrib.tutorials.evadventure + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.evadventure.build_techdemo + evennia.contrib.tutorials.evadventure.build_world + evennia.contrib.tutorials.evadventure.characters + evennia.contrib.tutorials.evadventure.combat_turnbased + evennia.contrib.tutorials.evadventure.commands + evennia.contrib.tutorials.evadventure.dungeon + evennia.contrib.tutorials.evadventure.enums + evennia.contrib.tutorials.evadventure.equipment + evennia.contrib.tutorials.evadventure.npcs + evennia.contrib.tutorials.evadventure.objects + evennia.contrib.tutorials.evadventure.quests + evennia.contrib.tutorials.evadventure.random_tables + evennia.contrib.tutorials.evadventure.rooms + evennia.contrib.tutorials.evadventure.rules + evennia.contrib.tutorials.evadventure.shops + evennia.contrib.tutorials.evadventure.utils + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.evadventure.tests diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.rules.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.rules.rst new file mode 100644 index 0000000000..a47b67eae1 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.rules.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.rules module +================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.rules + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.shops.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.shops.rst new file mode 100644 index 0000000000..6895f95604 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.shops.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.shops module +================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.shops + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md index 93eae7ea5d..f1147ca9e8 100644 --- a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.md @@ -13,6 +13,7 @@ evennia.contrib.tutorials.evadventure.tests :maxdepth: 6 evennia.contrib.tutorials.evadventure.tests.mixins + evennia.contrib.tutorials.evadventure.tests.test_characters evennia.contrib.tutorials.evadventure.tests.test_combat evennia.contrib.tutorials.evadventure.tests.test_commands evennia.contrib.tutorials.evadventure.tests.test_dungeon diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.mixins.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.mixins.rst new file mode 100644 index 0000000000..9971ff0281 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.mixins.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.mixins module +========================================================= + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.mixins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.rst new file mode 100644 index 0000000000..41bd8553d4 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.rst @@ -0,0 +1,21 @@ +evennia.contrib.tutorials.evadventure.tests package +=================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.evadventure.tests.mixins + evennia.contrib.tutorials.evadventure.tests.test_characters + evennia.contrib.tutorials.evadventure.tests.test_combat + evennia.contrib.tutorials.evadventure.tests.test_commands + evennia.contrib.tutorials.evadventure.tests.test_dungeon + evennia.contrib.tutorials.evadventure.tests.test_quests + evennia.contrib.tutorials.evadventure.tests.test_rules + evennia.contrib.tutorials.evadventure.tests.test_utils diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_characters.md b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_characters.md new file mode 100644 index 0000000000..df42c7515d --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_characters.md @@ -0,0 +1,10 @@ +```{eval-rst} +evennia.contrib.tutorials.evadventure.tests.test\_characters +=================================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_characters + :members: + :undoc-members: + :show-inheritance: + +``` \ No newline at end of file diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_characters.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_characters.rst new file mode 100644 index 0000000000..cfffdb7b67 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_characters.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.test\_characters module +=================================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_characters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_combat.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_combat.rst new file mode 100644 index 0000000000..a3d6713ab7 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_combat.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.test\_combat module +=============================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_combat + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_commands.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_commands.rst new file mode 100644 index 0000000000..d94c8730a7 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_commands.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.test\_commands module +================================================================= + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_dungeon.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_dungeon.rst new file mode 100644 index 0000000000..d00a1291a2 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_dungeon.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.test\_dungeon module +================================================================ + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_dungeon + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_quests.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_quests.rst new file mode 100644 index 0000000000..0397f0bd11 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_quests.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.test\_quests module +=============================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_quests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_rules.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_rules.rst new file mode 100644 index 0000000000..3fc6eb9d97 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_rules.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.test\_rules module +============================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_rules + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_utils.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_utils.rst new file mode 100644 index 0000000000..39d3aba676 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.tests.test_utils.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.tests.test\_utils module +============================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.tests.test_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.evadventure.utils.rst b/docs/source/api/evennia.contrib.tutorials.evadventure.utils.rst new file mode 100644 index 0000000000..bf410e4770 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.evadventure.utils.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.evadventure.utils module +================================================== + +.. automodule:: evennia.contrib.tutorials.evadventure.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.mirror.mirror.rst b/docs/source/api/evennia.contrib.tutorials.mirror.mirror.rst new file mode 100644 index 0000000000..be050f2fb4 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.mirror.mirror.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.mirror.mirror module +============================================== + +.. automodule:: evennia.contrib.tutorials.mirror.mirror + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.mirror.rst b/docs/source/api/evennia.contrib.tutorials.mirror.rst new file mode 100644 index 0000000000..59d4a44097 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.mirror.rst @@ -0,0 +1,14 @@ +evennia.contrib.tutorials.mirror package +======================================== + +.. automodule:: evennia.contrib.tutorials.mirror + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.mirror.mirror diff --git a/docs/source/api/evennia.contrib.tutorials.red_button.red_button.rst b/docs/source/api/evennia.contrib.tutorials.red_button.red_button.rst new file mode 100644 index 0000000000..1b1be56930 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.red_button.red_button.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.red\_button.red\_button module +======================================================== + +.. automodule:: evennia.contrib.tutorials.red_button.red_button + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.red_button.rst b/docs/source/api/evennia.contrib.tutorials.red_button.rst new file mode 100644 index 0000000000..8d2f10812e --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.red_button.rst @@ -0,0 +1,14 @@ +evennia.contrib.tutorials.red\_button package +============================================= + +.. automodule:: evennia.contrib.tutorials.red_button + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.red_button.red_button diff --git a/docs/source/api/evennia.contrib.tutorials.rst b/docs/source/api/evennia.contrib.tutorials.rst new file mode 100644 index 0000000000..0d978ea018 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.rst @@ -0,0 +1,19 @@ +evennia.contrib.tutorials package +================================= + +.. automodule:: evennia.contrib.tutorials + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.batchprocessor + evennia.contrib.tutorials.bodyfunctions + evennia.contrib.tutorials.evadventure + evennia.contrib.tutorials.mirror + evennia.contrib.tutorials.red_button + evennia.contrib.tutorials.talking_npc + evennia.contrib.tutorials.tutorial_world diff --git a/docs/source/api/evennia.contrib.tutorials.talking_npc.rst b/docs/source/api/evennia.contrib.tutorials.talking_npc.rst new file mode 100644 index 0000000000..8ca55a58f1 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.talking_npc.rst @@ -0,0 +1,15 @@ +evennia.contrib.tutorials.talking\_npc package +============================================== + +.. automodule:: evennia.contrib.tutorials.talking_npc + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.talking_npc.talking_npc + evennia.contrib.tutorials.talking_npc.tests diff --git a/docs/source/api/evennia.contrib.tutorials.talking_npc.talking_npc.rst b/docs/source/api/evennia.contrib.tutorials.talking_npc.talking_npc.rst new file mode 100644 index 0000000000..5205935812 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.talking_npc.talking_npc.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.talking\_npc.talking\_npc module +========================================================== + +.. automodule:: evennia.contrib.tutorials.talking_npc.talking_npc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.talking_npc.tests.rst b/docs/source/api/evennia.contrib.tutorials.talking_npc.tests.rst new file mode 100644 index 0000000000..66395a2d4a --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.talking_npc.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.talking\_npc.tests module +=================================================== + +.. automodule:: evennia.contrib.tutorials.talking_npc.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.tutorial_world.intro_menu.rst b/docs/source/api/evennia.contrib.tutorials.tutorial_world.intro_menu.rst new file mode 100644 index 0000000000..9714358cb0 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.tutorial_world.intro_menu.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.tutorial\_world.intro\_menu module +============================================================ + +.. automodule:: evennia.contrib.tutorials.tutorial_world.intro_menu + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.tutorial_world.mob.rst b/docs/source/api/evennia.contrib.tutorials.tutorial_world.mob.rst new file mode 100644 index 0000000000..94fded7116 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.tutorial_world.mob.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.tutorial\_world.mob module +==================================================== + +.. automodule:: evennia.contrib.tutorials.tutorial_world.mob + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.tutorial_world.objects.rst b/docs/source/api/evennia.contrib.tutorials.tutorial_world.objects.rst new file mode 100644 index 0000000000..bcf874d7be --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.tutorial_world.objects.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.tutorial\_world.objects module +======================================================== + +.. automodule:: evennia.contrib.tutorials.tutorial_world.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.tutorial_world.rooms.rst b/docs/source/api/evennia.contrib.tutorials.tutorial_world.rooms.rst new file mode 100644 index 0000000000..bffd71dce1 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.tutorial_world.rooms.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.tutorial\_world.rooms module +====================================================== + +.. automodule:: evennia.contrib.tutorials.tutorial_world.rooms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorials.tutorial_world.rst b/docs/source/api/evennia.contrib.tutorials.tutorial_world.rst new file mode 100644 index 0000000000..b81db86cb8 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.tutorial_world.rst @@ -0,0 +1,18 @@ +evennia.contrib.tutorials.tutorial\_world package +================================================= + +.. automodule:: evennia.contrib.tutorials.tutorial_world + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.tutorials.tutorial_world.intro_menu + evennia.contrib.tutorials.tutorial_world.mob + evennia.contrib.tutorials.tutorial_world.objects + evennia.contrib.tutorials.tutorial_world.rooms + evennia.contrib.tutorials.tutorial_world.tests diff --git a/docs/source/api/evennia.contrib.tutorials.tutorial_world.tests.rst b/docs/source/api/evennia.contrib.tutorials.tutorial_world.tests.rst new file mode 100644 index 0000000000..16d88cf6e4 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorials.tutorial_world.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorials.tutorial\_world.tests module +====================================================== + +.. automodule:: evennia.contrib.tutorials.tutorial_world.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.auditing.outputs.rst b/docs/source/api/evennia.contrib.utils.auditing.outputs.rst new file mode 100644 index 0000000000..5d348fdbbb --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.auditing.outputs.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.auditing.outputs module +============================================= + +.. automodule:: evennia.contrib.utils.auditing.outputs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.auditing.rst b/docs/source/api/evennia.contrib.utils.auditing.rst new file mode 100644 index 0000000000..a0297059b2 --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.auditing.rst @@ -0,0 +1,16 @@ +evennia.contrib.utils.auditing package +====================================== + +.. automodule:: evennia.contrib.utils.auditing + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.utils.auditing.outputs + evennia.contrib.utils.auditing.server + evennia.contrib.utils.auditing.tests diff --git a/docs/source/api/evennia.contrib.utils.auditing.server.rst b/docs/source/api/evennia.contrib.utils.auditing.server.rst new file mode 100644 index 0000000000..53aeaa214b --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.auditing.server.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.auditing.server module +============================================ + +.. automodule:: evennia.contrib.utils.auditing.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.auditing.tests.rst b/docs/source/api/evennia.contrib.utils.auditing.tests.rst new file mode 100644 index 0000000000..de177d2714 --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.auditing.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.auditing.tests module +=========================================== + +.. automodule:: evennia.contrib.utils.auditing.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.fieldfill.fieldfill.rst b/docs/source/api/evennia.contrib.utils.fieldfill.fieldfill.rst new file mode 100644 index 0000000000..fc7dfa3a35 --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.fieldfill.fieldfill.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.fieldfill.fieldfill module +================================================ + +.. automodule:: evennia.contrib.utils.fieldfill.fieldfill + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.fieldfill.rst b/docs/source/api/evennia.contrib.utils.fieldfill.rst new file mode 100644 index 0000000000..de5b345a0e --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.fieldfill.rst @@ -0,0 +1,14 @@ +evennia.contrib.utils.fieldfill package +======================================= + +.. automodule:: evennia.contrib.utils.fieldfill + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.utils.fieldfill.fieldfill diff --git a/docs/source/api/evennia.contrib.utils.random_string_generator.random_string_generator.rst b/docs/source/api/evennia.contrib.utils.random_string_generator.random_string_generator.rst new file mode 100644 index 0000000000..625f4f1f98 --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.random_string_generator.random_string_generator.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.random\_string\_generator.random\_string\_generator module +================================================================================ + +.. automodule:: evennia.contrib.utils.random_string_generator.random_string_generator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.random_string_generator.rst b/docs/source/api/evennia.contrib.utils.random_string_generator.rst new file mode 100644 index 0000000000..7034519c48 --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.random_string_generator.rst @@ -0,0 +1,15 @@ +evennia.contrib.utils.random\_string\_generator package +======================================================= + +.. automodule:: evennia.contrib.utils.random_string_generator + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.utils.random_string_generator.random_string_generator + evennia.contrib.utils.random_string_generator.tests diff --git a/docs/source/api/evennia.contrib.utils.random_string_generator.tests.rst b/docs/source/api/evennia.contrib.utils.random_string_generator.tests.rst new file mode 100644 index 0000000000..e32af2917f --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.random_string_generator.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.random\_string\_generator.tests module +============================================================ + +.. automodule:: evennia.contrib.utils.random_string_generator.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.rst b/docs/source/api/evennia.contrib.utils.rst new file mode 100644 index 0000000000..e157f0937d --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.rst @@ -0,0 +1,16 @@ +evennia.contrib.utils package +============================= + +.. automodule:: evennia.contrib.utils + :members: + :undoc-members: + :show-inheritance: + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.utils.auditing + evennia.contrib.utils.fieldfill + evennia.contrib.utils.random_string_generator + evennia.contrib.utils.tree_select diff --git a/docs/source/api/evennia.contrib.utils.tree_select.rst b/docs/source/api/evennia.contrib.utils.tree_select.rst new file mode 100644 index 0000000000..0b30d36be2 --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.tree_select.rst @@ -0,0 +1,15 @@ +evennia.contrib.utils.tree\_select package +========================================== + +.. automodule:: evennia.contrib.utils.tree_select + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.contrib.utils.tree_select.tests + evennia.contrib.utils.tree_select.tree_select diff --git a/docs/source/api/evennia.contrib.utils.tree_select.tests.rst b/docs/source/api/evennia.contrib.utils.tree_select.tests.rst new file mode 100644 index 0000000000..7aec68524b --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.tree_select.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.tree\_select.tests module +=============================================== + +.. automodule:: evennia.contrib.utils.tree_select.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.utils.tree_select.tree_select.rst b/docs/source/api/evennia.contrib.utils.tree_select.tree_select.rst new file mode 100644 index 0000000000..4f089494a0 --- /dev/null +++ b/docs/source/api/evennia.contrib.utils.tree_select.tree_select.rst @@ -0,0 +1,7 @@ +evennia.contrib.utils.tree\_select.tree\_select module +====================================================== + +.. automodule:: evennia.contrib.utils.tree_select.tree_select + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.help.filehelp.rst b/docs/source/api/evennia.help.filehelp.rst new file mode 100644 index 0000000000..8febe4e120 --- /dev/null +++ b/docs/source/api/evennia.help.filehelp.rst @@ -0,0 +1,7 @@ +evennia.help.filehelp module +============================ + +.. automodule:: evennia.help.filehelp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.help.manager.rst b/docs/source/api/evennia.help.manager.rst new file mode 100644 index 0000000000..46b62b695c --- /dev/null +++ b/docs/source/api/evennia.help.manager.rst @@ -0,0 +1,7 @@ +evennia.help.manager module +=========================== + +.. automodule:: evennia.help.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.help.models.rst b/docs/source/api/evennia.help.models.rst new file mode 100644 index 0000000000..18c3dfccd5 --- /dev/null +++ b/docs/source/api/evennia.help.models.rst @@ -0,0 +1,7 @@ +evennia.help.models module +========================== + +.. automodule:: evennia.help.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.help.rst b/docs/source/api/evennia.help.rst new file mode 100644 index 0000000000..1054d0a90e --- /dev/null +++ b/docs/source/api/evennia.help.rst @@ -0,0 +1,17 @@ +evennia.help package +==================== + +.. automodule:: evennia.help + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.help.filehelp + evennia.help.manager + evennia.help.models + evennia.help.utils diff --git a/docs/source/api/evennia.help.utils.rst b/docs/source/api/evennia.help.utils.rst new file mode 100644 index 0000000000..788f281ce2 --- /dev/null +++ b/docs/source/api/evennia.help.utils.rst @@ -0,0 +1,7 @@ +evennia.help.utils module +========================= + +.. automodule:: evennia.help.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.locks.lockfuncs.rst b/docs/source/api/evennia.locks.lockfuncs.rst new file mode 100644 index 0000000000..edb024f28e --- /dev/null +++ b/docs/source/api/evennia.locks.lockfuncs.rst @@ -0,0 +1,7 @@ +evennia.locks.lockfuncs module +============================== + +.. automodule:: evennia.locks.lockfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.locks.lockhandler.rst b/docs/source/api/evennia.locks.lockhandler.rst new file mode 100644 index 0000000000..0d5334e56d --- /dev/null +++ b/docs/source/api/evennia.locks.lockhandler.rst @@ -0,0 +1,7 @@ +evennia.locks.lockhandler module +================================ + +.. automodule:: evennia.locks.lockhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.locks.rst b/docs/source/api/evennia.locks.rst new file mode 100644 index 0000000000..c3661ed277 --- /dev/null +++ b/docs/source/api/evennia.locks.rst @@ -0,0 +1,15 @@ +evennia.locks package +===================== + +.. automodule:: evennia.locks + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.locks.lockfuncs + evennia.locks.lockhandler diff --git a/docs/source/api/evennia.objects.manager.rst b/docs/source/api/evennia.objects.manager.rst new file mode 100644 index 0000000000..802bea6c37 --- /dev/null +++ b/docs/source/api/evennia.objects.manager.rst @@ -0,0 +1,7 @@ +evennia.objects.manager module +============================== + +.. automodule:: evennia.objects.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.models.rst b/docs/source/api/evennia.objects.models.rst new file mode 100644 index 0000000000..dd33d05d0a --- /dev/null +++ b/docs/source/api/evennia.objects.models.rst @@ -0,0 +1,7 @@ +evennia.objects.models module +============================= + +.. automodule:: evennia.objects.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.objects.rst b/docs/source/api/evennia.objects.objects.rst new file mode 100644 index 0000000000..7061bed07a --- /dev/null +++ b/docs/source/api/evennia.objects.objects.rst @@ -0,0 +1,7 @@ +evennia.objects.objects module +============================== + +.. automodule:: evennia.objects.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.rst b/docs/source/api/evennia.objects.rst new file mode 100644 index 0000000000..7532d1ac11 --- /dev/null +++ b/docs/source/api/evennia.objects.rst @@ -0,0 +1,16 @@ +evennia.objects package +======================= + +.. automodule:: evennia.objects + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.objects.manager + evennia.objects.models + evennia.objects.objects diff --git a/docs/source/api/evennia.prototypes.menus.rst b/docs/source/api/evennia.prototypes.menus.rst new file mode 100644 index 0000000000..6f80f77bd6 --- /dev/null +++ b/docs/source/api/evennia.prototypes.menus.rst @@ -0,0 +1,7 @@ +evennia.prototypes.menus module +=============================== + +.. automodule:: evennia.prototypes.menus + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.protfuncs.rst b/docs/source/api/evennia.prototypes.protfuncs.rst new file mode 100644 index 0000000000..b6b9ce4616 --- /dev/null +++ b/docs/source/api/evennia.prototypes.protfuncs.rst @@ -0,0 +1,7 @@ +evennia.prototypes.protfuncs module +=================================== + +.. automodule:: evennia.prototypes.protfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.prototypes.rst b/docs/source/api/evennia.prototypes.prototypes.rst new file mode 100644 index 0000000000..bb1ed1014f --- /dev/null +++ b/docs/source/api/evennia.prototypes.prototypes.rst @@ -0,0 +1,7 @@ +evennia.prototypes.prototypes module +==================================== + +.. automodule:: evennia.prototypes.prototypes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.rst b/docs/source/api/evennia.prototypes.rst new file mode 100644 index 0000000000..7efa2bafbc --- /dev/null +++ b/docs/source/api/evennia.prototypes.rst @@ -0,0 +1,17 @@ +evennia.prototypes package +========================== + +.. automodule:: evennia.prototypes + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.prototypes.menus + evennia.prototypes.protfuncs + evennia.prototypes.prototypes + evennia.prototypes.spawner diff --git a/docs/source/api/evennia.prototypes.spawner.rst b/docs/source/api/evennia.prototypes.spawner.rst new file mode 100644 index 0000000000..e94c8bc5d6 --- /dev/null +++ b/docs/source/api/evennia.prototypes.spawner.rst @@ -0,0 +1,7 @@ +evennia.prototypes.spawner module +================================= + +.. automodule:: evennia.prototypes.spawner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.rst b/docs/source/api/evennia.rst new file mode 100644 index 0000000000..96692c5117 --- /dev/null +++ b/docs/source/api/evennia.rst @@ -0,0 +1,32 @@ +evennia package +=============== + +.. automodule:: evennia + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.settings_default + + +.. toctree:: + :maxdepth: 6 + + evennia.accounts + evennia.commands + evennia.comms + evennia.contrib + evennia.help + evennia.locks + evennia.objects + evennia.prototypes + evennia.scripts + evennia.server + evennia.typeclasses + evennia.utils + evennia.web diff --git a/docs/source/api/evennia.scripts.manager.rst b/docs/source/api/evennia.scripts.manager.rst new file mode 100644 index 0000000000..74b306ed8d --- /dev/null +++ b/docs/source/api/evennia.scripts.manager.rst @@ -0,0 +1,7 @@ +evennia.scripts.manager module +============================== + +.. automodule:: evennia.scripts.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.models.rst b/docs/source/api/evennia.scripts.models.rst new file mode 100644 index 0000000000..f7a1417fae --- /dev/null +++ b/docs/source/api/evennia.scripts.models.rst @@ -0,0 +1,7 @@ +evennia.scripts.models module +============================= + +.. automodule:: evennia.scripts.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.monitorhandler.rst b/docs/source/api/evennia.scripts.monitorhandler.rst new file mode 100644 index 0000000000..56b124ddc8 --- /dev/null +++ b/docs/source/api/evennia.scripts.monitorhandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.monitorhandler module +===================================== + +.. automodule:: evennia.scripts.monitorhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.rst b/docs/source/api/evennia.scripts.rst new file mode 100644 index 0000000000..8a11356c9d --- /dev/null +++ b/docs/source/api/evennia.scripts.rst @@ -0,0 +1,20 @@ +evennia.scripts package +======================= + +.. automodule:: evennia.scripts + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.scripts.manager + evennia.scripts.models + evennia.scripts.monitorhandler + evennia.scripts.scripthandler + evennia.scripts.scripts + evennia.scripts.taskhandler + evennia.scripts.tickerhandler diff --git a/docs/source/api/evennia.scripts.scripthandler.rst b/docs/source/api/evennia.scripts.scripthandler.rst new file mode 100644 index 0000000000..2b249b3a17 --- /dev/null +++ b/docs/source/api/evennia.scripts.scripthandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.scripthandler module +==================================== + +.. automodule:: evennia.scripts.scripthandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.scripts.rst b/docs/source/api/evennia.scripts.scripts.rst new file mode 100644 index 0000000000..f23529fb57 --- /dev/null +++ b/docs/source/api/evennia.scripts.scripts.rst @@ -0,0 +1,7 @@ +evennia.scripts.scripts module +============================== + +.. automodule:: evennia.scripts.scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.taskhandler.rst b/docs/source/api/evennia.scripts.taskhandler.rst new file mode 100644 index 0000000000..194d9f4639 --- /dev/null +++ b/docs/source/api/evennia.scripts.taskhandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.taskhandler module +================================== + +.. automodule:: evennia.scripts.taskhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.tickerhandler.rst b/docs/source/api/evennia.scripts.tickerhandler.rst new file mode 100644 index 0000000000..cf1992afb4 --- /dev/null +++ b/docs/source/api/evennia.scripts.tickerhandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.tickerhandler module +==================================== + +.. automodule:: evennia.scripts.tickerhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.amp_client.rst b/docs/source/api/evennia.server.amp_client.rst new file mode 100644 index 0000000000..9aa130109f --- /dev/null +++ b/docs/source/api/evennia.server.amp_client.rst @@ -0,0 +1,7 @@ +evennia.server.amp\_client module +================================= + +.. automodule:: evennia.server.amp_client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.connection_wizard.rst b/docs/source/api/evennia.server.connection_wizard.rst new file mode 100644 index 0000000000..52ad626510 --- /dev/null +++ b/docs/source/api/evennia.server.connection_wizard.rst @@ -0,0 +1,7 @@ +evennia.server.connection\_wizard module +======================================== + +.. automodule:: evennia.server.connection_wizard + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.deprecations.rst b/docs/source/api/evennia.server.deprecations.rst new file mode 100644 index 0000000000..aacb232c1f --- /dev/null +++ b/docs/source/api/evennia.server.deprecations.rst @@ -0,0 +1,7 @@ +evennia.server.deprecations module +================================== + +.. automodule:: evennia.server.deprecations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.evennia_launcher.rst b/docs/source/api/evennia.server.evennia_launcher.rst new file mode 100644 index 0000000000..70821160b8 --- /dev/null +++ b/docs/source/api/evennia.server.evennia_launcher.rst @@ -0,0 +1,7 @@ +evennia.server.evennia\_launcher module +======================================= + +.. automodule:: evennia.server.evennia_launcher + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.game_index_client.client.rst b/docs/source/api/evennia.server.game_index_client.client.rst new file mode 100644 index 0000000000..1faec15410 --- /dev/null +++ b/docs/source/api/evennia.server.game_index_client.client.rst @@ -0,0 +1,7 @@ +evennia.server.game\_index\_client.client module +================================================ + +.. automodule:: evennia.server.game_index_client.client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.game_index_client.rst b/docs/source/api/evennia.server.game_index_client.rst new file mode 100644 index 0000000000..46d81e24d9 --- /dev/null +++ b/docs/source/api/evennia.server.game_index_client.rst @@ -0,0 +1,15 @@ +evennia.server.game\_index\_client package +========================================== + +.. automodule:: evennia.server.game_index_client + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.server.game_index_client.client + evennia.server.game_index_client.service diff --git a/docs/source/api/evennia.server.game_index_client.service.rst b/docs/source/api/evennia.server.game_index_client.service.rst new file mode 100644 index 0000000000..d6061f642c --- /dev/null +++ b/docs/source/api/evennia.server.game_index_client.service.rst @@ -0,0 +1,7 @@ +evennia.server.game\_index\_client.service module +================================================= + +.. automodule:: evennia.server.game_index_client.service + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.initial_setup.rst b/docs/source/api/evennia.server.initial_setup.rst new file mode 100644 index 0000000000..f03c870f24 --- /dev/null +++ b/docs/source/api/evennia.server.initial_setup.rst @@ -0,0 +1,7 @@ +evennia.server.initial\_setup module +==================================== + +.. automodule:: evennia.server.initial_setup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.inputfuncs.rst b/docs/source/api/evennia.server.inputfuncs.rst new file mode 100644 index 0000000000..60a771f777 --- /dev/null +++ b/docs/source/api/evennia.server.inputfuncs.rst @@ -0,0 +1,7 @@ +evennia.server.inputfuncs module +================================ + +.. automodule:: evennia.server.inputfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.manager.rst b/docs/source/api/evennia.server.manager.rst new file mode 100644 index 0000000000..69f687203b --- /dev/null +++ b/docs/source/api/evennia.server.manager.rst @@ -0,0 +1,7 @@ +evennia.server.manager module +============================= + +.. automodule:: evennia.server.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.models.rst b/docs/source/api/evennia.server.models.rst new file mode 100644 index 0000000000..c5fadb43a9 --- /dev/null +++ b/docs/source/api/evennia.server.models.rst @@ -0,0 +1,7 @@ +evennia.server.models module +============================ + +.. automodule:: evennia.server.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.amp.rst b/docs/source/api/evennia.server.portal.amp.rst new file mode 100644 index 0000000000..bd11c4ba75 --- /dev/null +++ b/docs/source/api/evennia.server.portal.amp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.amp module +================================ + +.. automodule:: evennia.server.portal.amp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.amp_server.rst b/docs/source/api/evennia.server.portal.amp_server.rst new file mode 100644 index 0000000000..c401deb66f --- /dev/null +++ b/docs/source/api/evennia.server.portal.amp_server.rst @@ -0,0 +1,7 @@ +evennia.server.portal.amp\_server module +======================================== + +.. automodule:: evennia.server.portal.amp_server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.grapevine.rst b/docs/source/api/evennia.server.portal.grapevine.rst new file mode 100644 index 0000000000..f264ff5c58 --- /dev/null +++ b/docs/source/api/evennia.server.portal.grapevine.rst @@ -0,0 +1,7 @@ +evennia.server.portal.grapevine module +====================================== + +.. automodule:: evennia.server.portal.grapevine + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.irc.rst b/docs/source/api/evennia.server.portal.irc.rst new file mode 100644 index 0000000000..8600dfd321 --- /dev/null +++ b/docs/source/api/evennia.server.portal.irc.rst @@ -0,0 +1,7 @@ +evennia.server.portal.irc module +================================ + +.. automodule:: evennia.server.portal.irc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.mccp.rst b/docs/source/api/evennia.server.portal.mccp.rst new file mode 100644 index 0000000000..07b1b59ba4 --- /dev/null +++ b/docs/source/api/evennia.server.portal.mccp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.mccp module +================================= + +.. automodule:: evennia.server.portal.mccp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.mssp.rst b/docs/source/api/evennia.server.portal.mssp.rst new file mode 100644 index 0000000000..1c11924208 --- /dev/null +++ b/docs/source/api/evennia.server.portal.mssp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.mssp module +================================= + +.. automodule:: evennia.server.portal.mssp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.mxp.rst b/docs/source/api/evennia.server.portal.mxp.rst new file mode 100644 index 0000000000..4388abb641 --- /dev/null +++ b/docs/source/api/evennia.server.portal.mxp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.mxp module +================================ + +.. automodule:: evennia.server.portal.mxp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.naws.rst b/docs/source/api/evennia.server.portal.naws.rst new file mode 100644 index 0000000000..cb037f8ee4 --- /dev/null +++ b/docs/source/api/evennia.server.portal.naws.rst @@ -0,0 +1,7 @@ +evennia.server.portal.naws module +================================= + +.. automodule:: evennia.server.portal.naws + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.portal.rst b/docs/source/api/evennia.server.portal.portal.rst new file mode 100644 index 0000000000..0d2ec92400 --- /dev/null +++ b/docs/source/api/evennia.server.portal.portal.rst @@ -0,0 +1,7 @@ +evennia.server.portal.portal module +=================================== + +.. automodule:: evennia.server.portal.portal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.portalsessionhandler.rst b/docs/source/api/evennia.server.portal.portalsessionhandler.rst new file mode 100644 index 0000000000..f5287f88b8 --- /dev/null +++ b/docs/source/api/evennia.server.portal.portalsessionhandler.rst @@ -0,0 +1,7 @@ +evennia.server.portal.portalsessionhandler module +================================================= + +.. automodule:: evennia.server.portal.portalsessionhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.rss.rst b/docs/source/api/evennia.server.portal.rss.rst new file mode 100644 index 0000000000..e7dde8bf7f --- /dev/null +++ b/docs/source/api/evennia.server.portal.rss.rst @@ -0,0 +1,7 @@ +evennia.server.portal.rss module +================================ + +.. automodule:: evennia.server.portal.rss + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.rst b/docs/source/api/evennia.server.portal.rst new file mode 100644 index 0000000000..07e2590206 --- /dev/null +++ b/docs/source/api/evennia.server.portal.rst @@ -0,0 +1,34 @@ +evennia.server.portal package +============================= + +.. automodule:: evennia.server.portal + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.server.portal.amp + evennia.server.portal.amp_server + evennia.server.portal.grapevine + evennia.server.portal.irc + evennia.server.portal.mccp + evennia.server.portal.mssp + evennia.server.portal.mxp + evennia.server.portal.naws + evennia.server.portal.portal + evennia.server.portal.portalsessionhandler + evennia.server.portal.rss + evennia.server.portal.ssh + evennia.server.portal.ssl + evennia.server.portal.suppress_ga + evennia.server.portal.telnet + evennia.server.portal.telnet_oob + evennia.server.portal.telnet_ssl + evennia.server.portal.tests + evennia.server.portal.ttype + evennia.server.portal.webclient + evennia.server.portal.webclient_ajax diff --git a/docs/source/api/evennia.server.portal.ssh.rst b/docs/source/api/evennia.server.portal.ssh.rst new file mode 100644 index 0000000000..6cd0d8b114 --- /dev/null +++ b/docs/source/api/evennia.server.portal.ssh.rst @@ -0,0 +1,7 @@ +evennia.server.portal.ssh module +================================ + +.. automodule:: evennia.server.portal.ssh + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.ssl.rst b/docs/source/api/evennia.server.portal.ssl.rst new file mode 100644 index 0000000000..76a9344833 --- /dev/null +++ b/docs/source/api/evennia.server.portal.ssl.rst @@ -0,0 +1,7 @@ +evennia.server.portal.ssl module +================================ + +.. automodule:: evennia.server.portal.ssl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.suppress_ga.rst b/docs/source/api/evennia.server.portal.suppress_ga.rst new file mode 100644 index 0000000000..3dc234d103 --- /dev/null +++ b/docs/source/api/evennia.server.portal.suppress_ga.rst @@ -0,0 +1,7 @@ +evennia.server.portal.suppress\_ga module +========================================= + +.. automodule:: evennia.server.portal.suppress_ga + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.telnet.rst b/docs/source/api/evennia.server.portal.telnet.rst new file mode 100644 index 0000000000..debd283f04 --- /dev/null +++ b/docs/source/api/evennia.server.portal.telnet.rst @@ -0,0 +1,7 @@ +evennia.server.portal.telnet module +=================================== + +.. automodule:: evennia.server.portal.telnet + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.telnet_oob.rst b/docs/source/api/evennia.server.portal.telnet_oob.rst new file mode 100644 index 0000000000..a882430740 --- /dev/null +++ b/docs/source/api/evennia.server.portal.telnet_oob.rst @@ -0,0 +1,7 @@ +evennia.server.portal.telnet\_oob module +======================================== + +.. automodule:: evennia.server.portal.telnet_oob + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.telnet_ssl.rst b/docs/source/api/evennia.server.portal.telnet_ssl.rst new file mode 100644 index 0000000000..694f99dd2a --- /dev/null +++ b/docs/source/api/evennia.server.portal.telnet_ssl.rst @@ -0,0 +1,7 @@ +evennia.server.portal.telnet\_ssl module +======================================== + +.. automodule:: evennia.server.portal.telnet_ssl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.tests.rst b/docs/source/api/evennia.server.portal.tests.rst new file mode 100644 index 0000000000..d763f3d333 --- /dev/null +++ b/docs/source/api/evennia.server.portal.tests.rst @@ -0,0 +1,7 @@ +evennia.server.portal.tests module +================================== + +.. automodule:: evennia.server.portal.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.ttype.rst b/docs/source/api/evennia.server.portal.ttype.rst new file mode 100644 index 0000000000..3851ee81c1 --- /dev/null +++ b/docs/source/api/evennia.server.portal.ttype.rst @@ -0,0 +1,7 @@ +evennia.server.portal.ttype module +================================== + +.. automodule:: evennia.server.portal.ttype + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.webclient.rst b/docs/source/api/evennia.server.portal.webclient.rst new file mode 100644 index 0000000000..67ef7c1934 --- /dev/null +++ b/docs/source/api/evennia.server.portal.webclient.rst @@ -0,0 +1,7 @@ +evennia.server.portal.webclient module +====================================== + +.. automodule:: evennia.server.portal.webclient + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.webclient_ajax.rst b/docs/source/api/evennia.server.portal.webclient_ajax.rst new file mode 100644 index 0000000000..ea74aa238c --- /dev/null +++ b/docs/source/api/evennia.server.portal.webclient_ajax.rst @@ -0,0 +1,7 @@ +evennia.server.portal.webclient\_ajax module +============================================ + +.. automodule:: evennia.server.portal.webclient_ajax + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.dummyrunner.rst b/docs/source/api/evennia.server.profiling.dummyrunner.rst new file mode 100644 index 0000000000..510fc8061b --- /dev/null +++ b/docs/source/api/evennia.server.profiling.dummyrunner.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.dummyrunner module +=========================================== + +.. automodule:: evennia.server.profiling.dummyrunner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.dummyrunner_settings.rst b/docs/source/api/evennia.server.profiling.dummyrunner_settings.rst new file mode 100644 index 0000000000..20c4a9ccbe --- /dev/null +++ b/docs/source/api/evennia.server.profiling.dummyrunner_settings.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.dummyrunner\_settings module +===================================================== + +.. automodule:: evennia.server.profiling.dummyrunner_settings + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.memplot.rst b/docs/source/api/evennia.server.profiling.memplot.rst new file mode 100644 index 0000000000..671fe70e00 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.memplot.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.memplot module +======================================= + +.. automodule:: evennia.server.profiling.memplot + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.rst b/docs/source/api/evennia.server.profiling.rst new file mode 100644 index 0000000000..61d427e041 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.rst @@ -0,0 +1,20 @@ +evennia.server.profiling package +================================ + +.. automodule:: evennia.server.profiling + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.server.profiling.dummyrunner + evennia.server.profiling.dummyrunner_settings + evennia.server.profiling.memplot + evennia.server.profiling.settings_mixin + evennia.server.profiling.test_queries + evennia.server.profiling.tests + evennia.server.profiling.timetrace diff --git a/docs/source/api/evennia.server.profiling.settings_mixin.rst b/docs/source/api/evennia.server.profiling.settings_mixin.rst new file mode 100644 index 0000000000..ddadc21b48 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.settings_mixin.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.settings\_mixin module +=============================================== + +.. automodule:: evennia.server.profiling.settings_mixin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.test_queries.rst b/docs/source/api/evennia.server.profiling.test_queries.rst new file mode 100644 index 0000000000..a7ea4eeeb6 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.test_queries.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.test\_queries module +============================================= + +.. automodule:: evennia.server.profiling.test_queries + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.tests.rst b/docs/source/api/evennia.server.profiling.tests.rst new file mode 100644 index 0000000000..58d2c0a678 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.tests.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.tests module +===================================== + +.. automodule:: evennia.server.profiling.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.timetrace.rst b/docs/source/api/evennia.server.profiling.timetrace.rst new file mode 100644 index 0000000000..07a19a4b25 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.timetrace.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.timetrace module +========================================= + +.. automodule:: evennia.server.profiling.timetrace + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.rst b/docs/source/api/evennia.server.rst new file mode 100644 index 0000000000..1f5ac39e0a --- /dev/null +++ b/docs/source/api/evennia.server.rst @@ -0,0 +1,37 @@ +evennia.server package +====================== + +.. automodule:: evennia.server + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.server.amp_client + evennia.server.connection_wizard + evennia.server.deprecations + evennia.server.evennia_launcher + evennia.server.initial_setup + evennia.server.inputfuncs + evennia.server.manager + evennia.server.models + evennia.server.server + evennia.server.serversession + evennia.server.session + evennia.server.sessionhandler + evennia.server.signals + evennia.server.throttle + evennia.server.validators + evennia.server.webserver + + +.. toctree:: + :maxdepth: 6 + + evennia.server.game_index_client + evennia.server.portal + evennia.server.profiling diff --git a/docs/source/api/evennia.server.server.rst b/docs/source/api/evennia.server.server.rst new file mode 100644 index 0000000000..f19e598541 --- /dev/null +++ b/docs/source/api/evennia.server.server.rst @@ -0,0 +1,7 @@ +evennia.server.server module +============================ + +.. automodule:: evennia.server.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.serversession.rst b/docs/source/api/evennia.server.serversession.rst new file mode 100644 index 0000000000..9a34500eac --- /dev/null +++ b/docs/source/api/evennia.server.serversession.rst @@ -0,0 +1,7 @@ +evennia.server.serversession module +=================================== + +.. automodule:: evennia.server.serversession + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.session.rst b/docs/source/api/evennia.server.session.rst new file mode 100644 index 0000000000..724de92312 --- /dev/null +++ b/docs/source/api/evennia.server.session.rst @@ -0,0 +1,7 @@ +evennia.server.session module +============================= + +.. automodule:: evennia.server.session + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.sessionhandler.rst b/docs/source/api/evennia.server.sessionhandler.rst new file mode 100644 index 0000000000..2ecede5faa --- /dev/null +++ b/docs/source/api/evennia.server.sessionhandler.rst @@ -0,0 +1,7 @@ +evennia.server.sessionhandler module +==================================== + +.. automodule:: evennia.server.sessionhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.signals.rst b/docs/source/api/evennia.server.signals.rst new file mode 100644 index 0000000000..ab1f13cb8b --- /dev/null +++ b/docs/source/api/evennia.server.signals.rst @@ -0,0 +1,7 @@ +evennia.server.signals module +============================= + +.. automodule:: evennia.server.signals + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.throttle.rst b/docs/source/api/evennia.server.throttle.rst new file mode 100644 index 0000000000..95832cdda4 --- /dev/null +++ b/docs/source/api/evennia.server.throttle.rst @@ -0,0 +1,7 @@ +evennia.server.throttle module +============================== + +.. automodule:: evennia.server.throttle + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.validators.rst b/docs/source/api/evennia.server.validators.rst new file mode 100644 index 0000000000..3aa6cd87c5 --- /dev/null +++ b/docs/source/api/evennia.server.validators.rst @@ -0,0 +1,7 @@ +evennia.server.validators module +================================ + +.. automodule:: evennia.server.validators + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.webserver.rst b/docs/source/api/evennia.server.webserver.rst new file mode 100644 index 0000000000..286f51a9da --- /dev/null +++ b/docs/source/api/evennia.server.webserver.rst @@ -0,0 +1,7 @@ +evennia.server.webserver module +=============================== + +.. automodule:: evennia.server.webserver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.settings_default.rst b/docs/source/api/evennia.settings_default.rst new file mode 100644 index 0000000000..2c990344db --- /dev/null +++ b/docs/source/api/evennia.settings_default.rst @@ -0,0 +1,7 @@ +evennia.settings\_default module +================================ + +.. automodule:: evennia.settings_default + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.attributes.rst b/docs/source/api/evennia.typeclasses.attributes.rst new file mode 100644 index 0000000000..46239c9424 --- /dev/null +++ b/docs/source/api/evennia.typeclasses.attributes.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.attributes module +===================================== + +.. automodule:: evennia.typeclasses.attributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.managers.rst b/docs/source/api/evennia.typeclasses.managers.rst new file mode 100644 index 0000000000..2cf9c78593 --- /dev/null +++ b/docs/source/api/evennia.typeclasses.managers.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.managers module +=================================== + +.. automodule:: evennia.typeclasses.managers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.models.rst b/docs/source/api/evennia.typeclasses.models.rst new file mode 100644 index 0000000000..32307e4315 --- /dev/null +++ b/docs/source/api/evennia.typeclasses.models.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.models module +================================= + +.. automodule:: evennia.typeclasses.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.rst b/docs/source/api/evennia.typeclasses.rst new file mode 100644 index 0000000000..9609d8f468 --- /dev/null +++ b/docs/source/api/evennia.typeclasses.rst @@ -0,0 +1,17 @@ +evennia.typeclasses package +=========================== + +.. automodule:: evennia.typeclasses + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.typeclasses.attributes + evennia.typeclasses.managers + evennia.typeclasses.models + evennia.typeclasses.tags diff --git a/docs/source/api/evennia.typeclasses.tags.rst b/docs/source/api/evennia.typeclasses.tags.rst new file mode 100644 index 0000000000..bc091ae2a8 --- /dev/null +++ b/docs/source/api/evennia.typeclasses.tags.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.tags module +=============================== + +.. automodule:: evennia.typeclasses.tags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.ansi.rst b/docs/source/api/evennia.utils.ansi.rst new file mode 100644 index 0000000000..d49406af94 --- /dev/null +++ b/docs/source/api/evennia.utils.ansi.rst @@ -0,0 +1,7 @@ +evennia.utils.ansi module +========================= + +.. automodule:: evennia.utils.ansi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.batchprocessors.rst b/docs/source/api/evennia.utils.batchprocessors.rst new file mode 100644 index 0000000000..c6f59c7292 --- /dev/null +++ b/docs/source/api/evennia.utils.batchprocessors.rst @@ -0,0 +1,7 @@ +evennia.utils.batchprocessors module +==================================== + +.. automodule:: evennia.utils.batchprocessors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.containers.rst b/docs/source/api/evennia.utils.containers.rst new file mode 100644 index 0000000000..dc37c47de9 --- /dev/null +++ b/docs/source/api/evennia.utils.containers.rst @@ -0,0 +1,7 @@ +evennia.utils.containers module +=============================== + +.. automodule:: evennia.utils.containers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.create.rst b/docs/source/api/evennia.utils.create.rst new file mode 100644 index 0000000000..4245a2a902 --- /dev/null +++ b/docs/source/api/evennia.utils.create.rst @@ -0,0 +1,7 @@ +evennia.utils.create module +=========================== + +.. automodule:: evennia.utils.create + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.dbserialize.rst b/docs/source/api/evennia.utils.dbserialize.rst new file mode 100644 index 0000000000..5858563eb2 --- /dev/null +++ b/docs/source/api/evennia.utils.dbserialize.rst @@ -0,0 +1,7 @@ +evennia.utils.dbserialize module +================================ + +.. automodule:: evennia.utils.dbserialize + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.eveditor.rst b/docs/source/api/evennia.utils.eveditor.rst new file mode 100644 index 0000000000..80651e5f87 --- /dev/null +++ b/docs/source/api/evennia.utils.eveditor.rst @@ -0,0 +1,7 @@ +evennia.utils.eveditor module +============================= + +.. automodule:: evennia.utils.eveditor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evform.rst b/docs/source/api/evennia.utils.evform.rst new file mode 100644 index 0000000000..60321c7eda --- /dev/null +++ b/docs/source/api/evennia.utils.evform.rst @@ -0,0 +1,7 @@ +evennia.utils.evform module +=========================== + +.. automodule:: evennia.utils.evform + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evmenu.rst b/docs/source/api/evennia.utils.evmenu.rst new file mode 100644 index 0000000000..8ffb7f29d5 --- /dev/null +++ b/docs/source/api/evennia.utils.evmenu.rst @@ -0,0 +1,7 @@ +evennia.utils.evmenu module +=========================== + +.. automodule:: evennia.utils.evmenu + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evmore.rst b/docs/source/api/evennia.utils.evmore.rst new file mode 100644 index 0000000000..e403887f77 --- /dev/null +++ b/docs/source/api/evennia.utils.evmore.rst @@ -0,0 +1,7 @@ +evennia.utils.evmore module +=========================== + +.. automodule:: evennia.utils.evmore + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evtable.rst b/docs/source/api/evennia.utils.evtable.rst new file mode 100644 index 0000000000..a83c49745c --- /dev/null +++ b/docs/source/api/evennia.utils.evtable.rst @@ -0,0 +1,7 @@ +evennia.utils.evtable module +============================ + +.. automodule:: evennia.utils.evtable + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.funcparser.rst b/docs/source/api/evennia.utils.funcparser.rst new file mode 100644 index 0000000000..ad0694beac --- /dev/null +++ b/docs/source/api/evennia.utils.funcparser.rst @@ -0,0 +1,7 @@ +evennia.utils.funcparser module +=============================== + +.. automodule:: evennia.utils.funcparser + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.gametime.rst b/docs/source/api/evennia.utils.gametime.rst new file mode 100644 index 0000000000..d2675d3f27 --- /dev/null +++ b/docs/source/api/evennia.utils.gametime.rst @@ -0,0 +1,7 @@ +evennia.utils.gametime module +============================= + +.. automodule:: evennia.utils.gametime + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.idmapper.manager.rst b/docs/source/api/evennia.utils.idmapper.manager.rst new file mode 100644 index 0000000000..f3a49a13cd --- /dev/null +++ b/docs/source/api/evennia.utils.idmapper.manager.rst @@ -0,0 +1,7 @@ +evennia.utils.idmapper.manager module +===================================== + +.. automodule:: evennia.utils.idmapper.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.idmapper.models.rst b/docs/source/api/evennia.utils.idmapper.models.rst new file mode 100644 index 0000000000..61af1a2f79 --- /dev/null +++ b/docs/source/api/evennia.utils.idmapper.models.rst @@ -0,0 +1,7 @@ +evennia.utils.idmapper.models module +==================================== + +.. automodule:: evennia.utils.idmapper.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.idmapper.rst b/docs/source/api/evennia.utils.idmapper.rst new file mode 100644 index 0000000000..b8b5e8cee8 --- /dev/null +++ b/docs/source/api/evennia.utils.idmapper.rst @@ -0,0 +1,16 @@ +evennia.utils.idmapper package +============================== + +.. automodule:: evennia.utils.idmapper + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.utils.idmapper.manager + evennia.utils.idmapper.models + evennia.utils.idmapper.tests diff --git a/docs/source/api/evennia.utils.idmapper.tests.rst b/docs/source/api/evennia.utils.idmapper.tests.rst new file mode 100644 index 0000000000..7c0b427d65 --- /dev/null +++ b/docs/source/api/evennia.utils.idmapper.tests.rst @@ -0,0 +1,7 @@ +evennia.utils.idmapper.tests module +=================================== + +.. automodule:: evennia.utils.idmapper.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.logger.rst b/docs/source/api/evennia.utils.logger.rst new file mode 100644 index 0000000000..185538cfe6 --- /dev/null +++ b/docs/source/api/evennia.utils.logger.rst @@ -0,0 +1,7 @@ +evennia.utils.logger module +=========================== + +.. automodule:: evennia.utils.logger + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.optionclasses.rst b/docs/source/api/evennia.utils.optionclasses.rst new file mode 100644 index 0000000000..7982b36a5b --- /dev/null +++ b/docs/source/api/evennia.utils.optionclasses.rst @@ -0,0 +1,7 @@ +evennia.utils.optionclasses module +================================== + +.. automodule:: evennia.utils.optionclasses + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.optionhandler.rst b/docs/source/api/evennia.utils.optionhandler.rst new file mode 100644 index 0000000000..ff1a7f03ab --- /dev/null +++ b/docs/source/api/evennia.utils.optionhandler.rst @@ -0,0 +1,7 @@ +evennia.utils.optionhandler module +================================== + +.. automodule:: evennia.utils.optionhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.picklefield.rst b/docs/source/api/evennia.utils.picklefield.rst new file mode 100644 index 0000000000..a7039a1681 --- /dev/null +++ b/docs/source/api/evennia.utils.picklefield.rst @@ -0,0 +1,7 @@ +evennia.utils.picklefield module +================================ + +.. automodule:: evennia.utils.picklefield + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.rst b/docs/source/api/evennia.utils.rst new file mode 100644 index 0000000000..05d05e6a7d --- /dev/null +++ b/docs/source/api/evennia.utils.rst @@ -0,0 +1,41 @@ +evennia.utils package +===================== + +.. automodule:: evennia.utils + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.utils.ansi + evennia.utils.batchprocessors + evennia.utils.containers + evennia.utils.create + evennia.utils.dbserialize + evennia.utils.eveditor + evennia.utils.evform + evennia.utils.evmenu + evennia.utils.evmore + evennia.utils.evtable + evennia.utils.funcparser + evennia.utils.gametime + evennia.utils.logger + evennia.utils.optionclasses + evennia.utils.optionhandler + evennia.utils.picklefield + evennia.utils.search + evennia.utils.test_resources + evennia.utils.text2html + evennia.utils.utils + evennia.utils.validatorfuncs + + +.. toctree:: + :maxdepth: 6 + + evennia.utils.idmapper + evennia.utils.verb_conjugation diff --git a/docs/source/api/evennia.utils.search.rst b/docs/source/api/evennia.utils.search.rst new file mode 100644 index 0000000000..5602e68ddd --- /dev/null +++ b/docs/source/api/evennia.utils.search.rst @@ -0,0 +1,7 @@ +evennia.utils.search module +=========================== + +.. automodule:: evennia.utils.search + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.test_resources.rst b/docs/source/api/evennia.utils.test_resources.rst new file mode 100644 index 0000000000..1d5708d5aa --- /dev/null +++ b/docs/source/api/evennia.utils.test_resources.rst @@ -0,0 +1,7 @@ +evennia.utils.test\_resources module +==================================== + +.. automodule:: evennia.utils.test_resources + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.text2html.rst b/docs/source/api/evennia.utils.text2html.rst new file mode 100644 index 0000000000..1d2feefceb --- /dev/null +++ b/docs/source/api/evennia.utils.text2html.rst @@ -0,0 +1,7 @@ +evennia.utils.text2html module +============================== + +.. automodule:: evennia.utils.text2html + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.utils.rst b/docs/source/api/evennia.utils.utils.rst new file mode 100644 index 0000000000..d6eb2ca10d --- /dev/null +++ b/docs/source/api/evennia.utils.utils.rst @@ -0,0 +1,7 @@ +evennia.utils.utils module +========================== + +.. automodule:: evennia.utils.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.validatorfuncs.rst b/docs/source/api/evennia.utils.validatorfuncs.rst new file mode 100644 index 0000000000..1e723a11a9 --- /dev/null +++ b/docs/source/api/evennia.utils.validatorfuncs.rst @@ -0,0 +1,7 @@ +evennia.utils.validatorfuncs module +=================================== + +.. automodule:: evennia.utils.validatorfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.verb_conjugation.conjugate.rst b/docs/source/api/evennia.utils.verb_conjugation.conjugate.rst new file mode 100644 index 0000000000..e7b880e4ce --- /dev/null +++ b/docs/source/api/evennia.utils.verb_conjugation.conjugate.rst @@ -0,0 +1,7 @@ +evennia.utils.verb\_conjugation.conjugate module +================================================ + +.. automodule:: evennia.utils.verb_conjugation.conjugate + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.verb_conjugation.pronouns.rst b/docs/source/api/evennia.utils.verb_conjugation.pronouns.rst new file mode 100644 index 0000000000..a45ebc13e3 --- /dev/null +++ b/docs/source/api/evennia.utils.verb_conjugation.pronouns.rst @@ -0,0 +1,7 @@ +evennia.utils.verb\_conjugation.pronouns module +=============================================== + +.. automodule:: evennia.utils.verb_conjugation.pronouns + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.verb_conjugation.rst b/docs/source/api/evennia.utils.verb_conjugation.rst new file mode 100644 index 0000000000..f818f7e333 --- /dev/null +++ b/docs/source/api/evennia.utils.verb_conjugation.rst @@ -0,0 +1,16 @@ +evennia.utils.verb\_conjugation package +======================================= + +.. automodule:: evennia.utils.verb_conjugation + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.utils.verb_conjugation.conjugate + evennia.utils.verb_conjugation.pronouns + evennia.utils.verb_conjugation.tests diff --git a/docs/source/api/evennia.utils.verb_conjugation.tests.rst b/docs/source/api/evennia.utils.verb_conjugation.tests.rst new file mode 100644 index 0000000000..e0e008719d --- /dev/null +++ b/docs/source/api/evennia.utils.verb_conjugation.tests.rst @@ -0,0 +1,7 @@ +evennia.utils.verb\_conjugation.tests module +============================================ + +.. automodule:: evennia.utils.verb_conjugation.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.accounts.rst b/docs/source/api/evennia.web.admin.accounts.rst new file mode 100644 index 0000000000..1560e9824f --- /dev/null +++ b/docs/source/api/evennia.web.admin.accounts.rst @@ -0,0 +1,7 @@ +evennia.web.admin.accounts module +================================= + +.. automodule:: evennia.web.admin.accounts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.attributes.rst b/docs/source/api/evennia.web.admin.attributes.rst new file mode 100644 index 0000000000..f3f26036b1 --- /dev/null +++ b/docs/source/api/evennia.web.admin.attributes.rst @@ -0,0 +1,7 @@ +evennia.web.admin.attributes module +=================================== + +.. automodule:: evennia.web.admin.attributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.comms.rst b/docs/source/api/evennia.web.admin.comms.rst new file mode 100644 index 0000000000..91f4e8b473 --- /dev/null +++ b/docs/source/api/evennia.web.admin.comms.rst @@ -0,0 +1,7 @@ +evennia.web.admin.comms module +============================== + +.. automodule:: evennia.web.admin.comms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.frontpage.rst b/docs/source/api/evennia.web.admin.frontpage.rst new file mode 100644 index 0000000000..b3e67346bd --- /dev/null +++ b/docs/source/api/evennia.web.admin.frontpage.rst @@ -0,0 +1,7 @@ +evennia.web.admin.frontpage module +================================== + +.. automodule:: evennia.web.admin.frontpage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.help.rst b/docs/source/api/evennia.web.admin.help.rst new file mode 100644 index 0000000000..d7aeeb1b65 --- /dev/null +++ b/docs/source/api/evennia.web.admin.help.rst @@ -0,0 +1,7 @@ +evennia.web.admin.help module +============================= + +.. automodule:: evennia.web.admin.help + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.objects.rst b/docs/source/api/evennia.web.admin.objects.rst new file mode 100644 index 0000000000..ddbe501c8d --- /dev/null +++ b/docs/source/api/evennia.web.admin.objects.rst @@ -0,0 +1,7 @@ +evennia.web.admin.objects module +================================ + +.. automodule:: evennia.web.admin.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.rst b/docs/source/api/evennia.web.admin.rst new file mode 100644 index 0000000000..badbc7cc27 --- /dev/null +++ b/docs/source/api/evennia.web.admin.rst @@ -0,0 +1,24 @@ +evennia.web.admin package +========================= + +.. automodule:: evennia.web.admin + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.admin.accounts + evennia.web.admin.attributes + evennia.web.admin.comms + evennia.web.admin.frontpage + evennia.web.admin.help + evennia.web.admin.objects + evennia.web.admin.scripts + evennia.web.admin.server + evennia.web.admin.tags + evennia.web.admin.urls + evennia.web.admin.utils diff --git a/docs/source/api/evennia.web.admin.scripts.rst b/docs/source/api/evennia.web.admin.scripts.rst new file mode 100644 index 0000000000..837270273b --- /dev/null +++ b/docs/source/api/evennia.web.admin.scripts.rst @@ -0,0 +1,7 @@ +evennia.web.admin.scripts module +================================ + +.. automodule:: evennia.web.admin.scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.server.rst b/docs/source/api/evennia.web.admin.server.rst new file mode 100644 index 0000000000..8d48b56084 --- /dev/null +++ b/docs/source/api/evennia.web.admin.server.rst @@ -0,0 +1,7 @@ +evennia.web.admin.server module +=============================== + +.. automodule:: evennia.web.admin.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.tags.rst b/docs/source/api/evennia.web.admin.tags.rst new file mode 100644 index 0000000000..660153842d --- /dev/null +++ b/docs/source/api/evennia.web.admin.tags.rst @@ -0,0 +1,7 @@ +evennia.web.admin.tags module +============================= + +.. automodule:: evennia.web.admin.tags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.urls.rst b/docs/source/api/evennia.web.admin.urls.rst new file mode 100644 index 0000000000..0be8897db9 --- /dev/null +++ b/docs/source/api/evennia.web.admin.urls.rst @@ -0,0 +1,7 @@ +evennia.web.admin.urls module +============================= + +.. automodule:: evennia.web.admin.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.utils.rst b/docs/source/api/evennia.web.admin.utils.rst new file mode 100644 index 0000000000..c1d3998706 --- /dev/null +++ b/docs/source/api/evennia.web.admin.utils.rst @@ -0,0 +1,7 @@ +evennia.web.admin.utils module +============================== + +.. automodule:: evennia.web.admin.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.filters.rst b/docs/source/api/evennia.web.api.filters.rst new file mode 100644 index 0000000000..744719403a --- /dev/null +++ b/docs/source/api/evennia.web.api.filters.rst @@ -0,0 +1,7 @@ +evennia.web.api.filters module +============================== + +.. automodule:: evennia.web.api.filters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.permissions.rst b/docs/source/api/evennia.web.api.permissions.rst new file mode 100644 index 0000000000..688838decf --- /dev/null +++ b/docs/source/api/evennia.web.api.permissions.rst @@ -0,0 +1,7 @@ +evennia.web.api.permissions module +================================== + +.. automodule:: evennia.web.api.permissions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.root.rst b/docs/source/api/evennia.web.api.root.rst new file mode 100644 index 0000000000..6783ac550d --- /dev/null +++ b/docs/source/api/evennia.web.api.root.rst @@ -0,0 +1,7 @@ +evennia.web.api.root module +=========================== + +.. automodule:: evennia.web.api.root + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.rst b/docs/source/api/evennia.web.api.rst new file mode 100644 index 0000000000..55fada4570 --- /dev/null +++ b/docs/source/api/evennia.web.api.rst @@ -0,0 +1,20 @@ +evennia.web.api package +======================= + +.. automodule:: evennia.web.api + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.api.filters + evennia.web.api.permissions + evennia.web.api.root + evennia.web.api.serializers + evennia.web.api.tests + evennia.web.api.urls + evennia.web.api.views diff --git a/docs/source/api/evennia.web.api.serializers.rst b/docs/source/api/evennia.web.api.serializers.rst new file mode 100644 index 0000000000..d9b4769f32 --- /dev/null +++ b/docs/source/api/evennia.web.api.serializers.rst @@ -0,0 +1,7 @@ +evennia.web.api.serializers module +================================== + +.. automodule:: evennia.web.api.serializers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.tests.rst b/docs/source/api/evennia.web.api.tests.rst new file mode 100644 index 0000000000..a606ea56ef --- /dev/null +++ b/docs/source/api/evennia.web.api.tests.rst @@ -0,0 +1,7 @@ +evennia.web.api.tests module +============================ + +.. automodule:: evennia.web.api.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.urls.rst b/docs/source/api/evennia.web.api.urls.rst new file mode 100644 index 0000000000..14e05a5bea --- /dev/null +++ b/docs/source/api/evennia.web.api.urls.rst @@ -0,0 +1,7 @@ +evennia.web.api.urls module +=========================== + +.. automodule:: evennia.web.api.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.views.rst b/docs/source/api/evennia.web.api.views.rst new file mode 100644 index 0000000000..3bbff42175 --- /dev/null +++ b/docs/source/api/evennia.web.api.views.rst @@ -0,0 +1,7 @@ +evennia.web.api.views module +============================ + +.. automodule:: evennia.web.api.views + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.rst b/docs/source/api/evennia.web.rst new file mode 100644 index 0000000000..02e4610a68 --- /dev/null +++ b/docs/source/api/evennia.web.rst @@ -0,0 +1,25 @@ +evennia.web package +=================== + +.. automodule:: evennia.web + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.urls + + +.. toctree:: + :maxdepth: 6 + + evennia.web.admin + evennia.web.api + evennia.web.templatetags + evennia.web.utils + evennia.web.webclient + evennia.web.website diff --git a/docs/source/api/evennia.web.templatetags.addclass.rst b/docs/source/api/evennia.web.templatetags.addclass.rst new file mode 100644 index 0000000000..d6d9347ebf --- /dev/null +++ b/docs/source/api/evennia.web.templatetags.addclass.rst @@ -0,0 +1,7 @@ +evennia.web.templatetags.addclass module +======================================== + +.. automodule:: evennia.web.templatetags.addclass + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.templatetags.rst b/docs/source/api/evennia.web.templatetags.rst new file mode 100644 index 0000000000..0fe07514c7 --- /dev/null +++ b/docs/source/api/evennia.web.templatetags.rst @@ -0,0 +1,14 @@ +evennia.web.templatetags package +================================ + +.. automodule:: evennia.web.templatetags + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.templatetags.addclass diff --git a/docs/source/api/evennia.web.urls.rst b/docs/source/api/evennia.web.urls.rst new file mode 100644 index 0000000000..61de474486 --- /dev/null +++ b/docs/source/api/evennia.web.urls.rst @@ -0,0 +1,7 @@ +evennia.web.urls module +======================= + +.. automodule:: evennia.web.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.adminsite.rst b/docs/source/api/evennia.web.utils.adminsite.rst new file mode 100644 index 0000000000..32eb3ea6a6 --- /dev/null +++ b/docs/source/api/evennia.web.utils.adminsite.rst @@ -0,0 +1,7 @@ +evennia.web.utils.adminsite module +================================== + +.. automodule:: evennia.web.utils.adminsite + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.backends.rst b/docs/source/api/evennia.web.utils.backends.rst new file mode 100644 index 0000000000..92492878ed --- /dev/null +++ b/docs/source/api/evennia.web.utils.backends.rst @@ -0,0 +1,7 @@ +evennia.web.utils.backends module +================================= + +.. automodule:: evennia.web.utils.backends + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.general_context.rst b/docs/source/api/evennia.web.utils.general_context.rst new file mode 100644 index 0000000000..d561fc68ac --- /dev/null +++ b/docs/source/api/evennia.web.utils.general_context.rst @@ -0,0 +1,7 @@ +evennia.web.utils.general\_context module +========================================= + +.. automodule:: evennia.web.utils.general_context + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.middleware.rst b/docs/source/api/evennia.web.utils.middleware.rst new file mode 100644 index 0000000000..88faf3dc32 --- /dev/null +++ b/docs/source/api/evennia.web.utils.middleware.rst @@ -0,0 +1,7 @@ +evennia.web.utils.middleware module +=================================== + +.. automodule:: evennia.web.utils.middleware + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.rst b/docs/source/api/evennia.web.utils.rst new file mode 100644 index 0000000000..f2cfe08d8b --- /dev/null +++ b/docs/source/api/evennia.web.utils.rst @@ -0,0 +1,18 @@ +evennia.web.utils package +========================= + +.. automodule:: evennia.web.utils + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.utils.adminsite + evennia.web.utils.backends + evennia.web.utils.general_context + evennia.web.utils.middleware + evennia.web.utils.tests diff --git a/docs/source/api/evennia.web.utils.tests.rst b/docs/source/api/evennia.web.utils.tests.rst new file mode 100644 index 0000000000..830eca0c82 --- /dev/null +++ b/docs/source/api/evennia.web.utils.tests.rst @@ -0,0 +1,7 @@ +evennia.web.utils.tests module +============================== + +.. automodule:: evennia.web.utils.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.webclient.rst b/docs/source/api/evennia.web.webclient.rst new file mode 100644 index 0000000000..25c4f8fd47 --- /dev/null +++ b/docs/source/api/evennia.web.webclient.rst @@ -0,0 +1,15 @@ +evennia.web.webclient package +============================= + +.. automodule:: evennia.web.webclient + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.webclient.urls + evennia.web.webclient.views diff --git a/docs/source/api/evennia.web.webclient.urls.rst b/docs/source/api/evennia.web.webclient.urls.rst new file mode 100644 index 0000000000..c1838e45b7 --- /dev/null +++ b/docs/source/api/evennia.web.webclient.urls.rst @@ -0,0 +1,7 @@ +evennia.web.webclient.urls module +================================= + +.. automodule:: evennia.web.webclient.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.webclient.views.rst b/docs/source/api/evennia.web.webclient.views.rst new file mode 100644 index 0000000000..936aa320e1 --- /dev/null +++ b/docs/source/api/evennia.web.webclient.views.rst @@ -0,0 +1,7 @@ +evennia.web.webclient.views module +================================== + +.. automodule:: evennia.web.webclient.views + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.forms.rst b/docs/source/api/evennia.web.website.forms.rst new file mode 100644 index 0000000000..b9feb6871c --- /dev/null +++ b/docs/source/api/evennia.web.website.forms.rst @@ -0,0 +1,7 @@ +evennia.web.website.forms module +================================ + +.. automodule:: evennia.web.website.forms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.rst b/docs/source/api/evennia.web.website.rst new file mode 100644 index 0000000000..343c59b4d0 --- /dev/null +++ b/docs/source/api/evennia.web.website.rst @@ -0,0 +1,22 @@ +evennia.web.website package +=========================== + +.. automodule:: evennia.web.website + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.website.forms + evennia.web.website.tests + evennia.web.website.urls + + +.. toctree:: + :maxdepth: 6 + + evennia.web.website.views diff --git a/docs/source/api/evennia.web.website.tests.rst b/docs/source/api/evennia.web.website.tests.rst new file mode 100644 index 0000000000..02d7fdb626 --- /dev/null +++ b/docs/source/api/evennia.web.website.tests.rst @@ -0,0 +1,7 @@ +evennia.web.website.tests module +================================ + +.. automodule:: evennia.web.website.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.urls.rst b/docs/source/api/evennia.web.website.urls.rst new file mode 100644 index 0000000000..44aa148911 --- /dev/null +++ b/docs/source/api/evennia.web.website.urls.rst @@ -0,0 +1,7 @@ +evennia.web.website.urls module +=============================== + +.. automodule:: evennia.web.website.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.accounts.rst b/docs/source/api/evennia.web.website.views.accounts.rst new file mode 100644 index 0000000000..a8d3d405e3 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.accounts.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.accounts module +========================================= + +.. automodule:: evennia.web.website.views.accounts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.channels.rst b/docs/source/api/evennia.web.website.views.channels.rst new file mode 100644 index 0000000000..a37e9a155a --- /dev/null +++ b/docs/source/api/evennia.web.website.views.channels.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.channels module +========================================= + +.. automodule:: evennia.web.website.views.channels + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.characters.rst b/docs/source/api/evennia.web.website.views.characters.rst new file mode 100644 index 0000000000..0b79f02d9d --- /dev/null +++ b/docs/source/api/evennia.web.website.views.characters.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.characters module +=========================================== + +.. automodule:: evennia.web.website.views.characters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.errors.rst b/docs/source/api/evennia.web.website.views.errors.rst new file mode 100644 index 0000000000..02ac7d7f26 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.errors.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.errors module +======================================= + +.. automodule:: evennia.web.website.views.errors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.help.rst b/docs/source/api/evennia.web.website.views.help.rst new file mode 100644 index 0000000000..6fdec19532 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.help.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.help module +===================================== + +.. automodule:: evennia.web.website.views.help + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.index.rst b/docs/source/api/evennia.web.website.views.index.rst new file mode 100644 index 0000000000..febe26d613 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.index.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.index module +====================================== + +.. automodule:: evennia.web.website.views.index + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.mixins.rst b/docs/source/api/evennia.web.website.views.mixins.rst new file mode 100644 index 0000000000..d4c2f3fcdc --- /dev/null +++ b/docs/source/api/evennia.web.website.views.mixins.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.mixins module +======================================= + +.. automodule:: evennia.web.website.views.mixins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.objects.rst b/docs/source/api/evennia.web.website.views.objects.rst new file mode 100644 index 0000000000..d5c3b8f867 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.objects.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.objects module +======================================== + +.. automodule:: evennia.web.website.views.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.rst b/docs/source/api/evennia.web.website.views.rst new file mode 100644 index 0000000000..ed0580e44b --- /dev/null +++ b/docs/source/api/evennia.web.website.views.rst @@ -0,0 +1,21 @@ +evennia.web.website.views package +================================= + +.. automodule:: evennia.web.website.views + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.website.views.accounts + evennia.web.website.views.channels + evennia.web.website.views.characters + evennia.web.website.views.errors + evennia.web.website.views.help + evennia.web.website.views.index + evennia.web.website.views.mixins + evennia.web.website.views.objects diff --git a/evennia/contrib/tutorials/evadventure/characters.py b/evennia/contrib/tutorials/evadventure/characters.py index 50cce06d09..77c6b0370c 100644 --- a/evennia/contrib/tutorials/evadventure/characters.py +++ b/evennia/contrib/tutorials/evadventure/characters.py @@ -57,8 +57,10 @@ class LivingMixin: if healer is self: self.msg(f"|gYou heal yourself for {healed} health.|n") - else: + elif healer: self.msg(f"|g{healer.key} heals you for {healed} health.|n") + else: + self.msg(f"You are healed for {healed} health.") def at_damage(self, damage, attacker=None): """ @@ -82,15 +84,14 @@ class LivingMixin: """ pass - def at_do_loot(self, looted): + def at_pay(self, amount): """ - Called when looting another entity. - - Args: - looted: The thing to loot. + Get coins, but no more than we actually have. """ - looted.at_looted() + amount = min(amount, self.coins) + self.coins -= amount + return amount def at_looted(self, looter): """ @@ -101,9 +102,8 @@ class LivingMixin: """ max_steal = rules.dice.roll("1d10") - owned = self.coin - stolen = max(max_steal, owned) - self.coins -= stolen + stolen = self.at_pay(max_steal) + looter.coins += stolen self.location.msg_contents( @@ -125,6 +125,16 @@ class LivingMixin: """ pass + def at_do_loot(self, defeated_enemy): + """ + Called when looting another entity. + + Args: + defeated_enemy: The thing to loot. + + """ + defeated_enemy.at_looted(self) + def post_loot(self, defeated_enemy): """ Called just after having looted an enemy. @@ -138,8 +148,7 @@ class LivingMixin: class EvAdventureCharacter(LivingMixin, DefaultCharacter): """ - A Character for use with EvAdventure. This also works fine for - monsters and NPCS. + A Character for use with EvAdventure. """ @@ -153,17 +162,12 @@ class EvAdventureCharacter(LivingMixin, DefaultCharacter): wisdom = AttributeProperty(default=1) charisma = AttributeProperty(default=1) - exploration_speed = AttributeProperty(default=120) - combat_speed = AttributeProperty(default=40) - hp = AttributeProperty(default=4) hp_max = AttributeProperty(default=4) level = AttributeProperty(default=1) xp = AttributeProperty(default=0) coins = AttributeProperty(default=0) # copper coins - morale = AttributeProperty(default=9) # only used for NPC/monster morale checks - @lazy_property def equipment(self): """Allows to access equipment like char.equipment.worn""" @@ -244,13 +248,6 @@ class EvAdventureCharacter(LivingMixin, DefaultCharacter): """ if self.location.allow_death: rules.dice.roll_death(self) - if self.hp > 0: - # still alive, but lost some stats - self.location.msg_contents( - "|y$You() $conj(stagger) back and fall to the ground - alive, " - "but unable to move.|n", - from_obj=self, - ) else: self.location.msg_contents("|y$You() $conj(yield), beaten and out of the fight.|n") self.hp = self.hp_max diff --git a/evennia/contrib/tutorials/evadventure/equipment.py b/evennia/contrib/tutorials/evadventure/equipment.py index a0b04e5a11..c806d37573 100644 --- a/evennia/contrib/tutorials/evadventure/equipment.py +++ b/evennia/contrib/tutorials/evadventure/equipment.py @@ -144,7 +144,7 @@ class EquipmentHandler: ( # armor is listed using its defense, so we remove 10 from it # (11 is base no-armor value in Knave) - getattr(slots[WieldLocation.BODY], "armor", 11) - 10, + getattr(slots[WieldLocation.BODY], "armor", 1), # shields and helmets are listed by their bonus to armor getattr(slots[WieldLocation.SHIELD_HAND], "armor", 0), getattr(slots[WieldLocation.HEAD], "armor", 0), diff --git a/evennia/contrib/tutorials/evadventure/objects.py b/evennia/contrib/tutorials/evadventure/objects.py index 2807671c61..6ce919cea6 100644 --- a/evennia/contrib/tutorials/evadventure/objects.py +++ b/evennia/contrib/tutorials/evadventure/objects.py @@ -39,11 +39,11 @@ class EvAdventureObject(DefaultObject): value = AttributeProperty(0) # can also be an iterable, for adding multiple obj-type tags - obj_type = ObjType.TREASURE.value + obj_type = ObjType.GEAR def at_object_creation(self): for obj_type in make_iter(self.obj_type): - self.tags.add(obj_type, category="obj_type") + self.tags.add(obj_type.value, category="obj_type") def get_display_header(self, looker, **kwargs): return "" # this is handled by get_obj_stats @@ -68,43 +68,7 @@ class EvAdventureObject(DefaultObject): str: The help text, by default taken from the `.help_text` property. """ - return self.help_text - - def at_pre_use(self, user, *args, **kwargs): - """ - Called before this item is used. - - Args: - user (Object): The one using the item. - *args, **kwargs: Optional arguments. - - Return: - bool: False to stop usage. - - """ - return self.uses > 0 - - def at_use(self, user, *args, **kwargs): - """ - Called when this item is used. - - Args: - user (Object): The one using the item. - *args, **kwargs: Optional arguments. - - """ - pass - - def at_post_use(self, user, *args, **kwargs): - """ - Called after this item was used. - - Args: - user (Object): The one using the item. - *args, **kwargs: Optional arguments. - - """ - self.uses -= 1 + return "No help for this item." class EvAdventureObjectFiller(EvAdventureObject): @@ -124,13 +88,13 @@ class EvAdventureObjectFiller(EvAdventureObject): quality = AttributeProperty(0) -class EvAdventureQuest(EvAdventureObject): +class EvAdventureQuestObject(EvAdventureObject): """ A quest object. These cannot be sold and only be used for quest resolution. """ - obj_type = ObjType.QUEST.value + obj_type = ObjType.QUEST value = AttributeProperty(0) @@ -140,7 +104,7 @@ class EvAdventureTreasure(EvAdventureObject): """ - obj_type = ObjType.TREASURE.value + obj_type = ObjType.TREASURE value = AttributeProperty(100) @@ -151,7 +115,7 @@ class EvAdventureConsumable(EvAdventureObject): """ - obj_type = ObjType.CONSUMABLE.value + obj_type = ObjType.CONSUMABLE size = AttributeProperty(0.25) uses = AttributeProperty(1) @@ -188,7 +152,7 @@ class WeaponEmptyHand: """ - obj_type = ObjType.WEAPON.value + obj_type = ObjType.WEAPON key = "Empty Fists" inventory_use_slot = WieldLocation.WEAPON_HAND attack_type = Ability.STR @@ -206,7 +170,7 @@ class EvAdventureWeapon(EvAdventureObject): """ - obj_type = ObjType.WEAPON.value + obj_type = ObjType.WEAPON inventory_use_slot = AttributeProperty(WieldLocation.WEAPON_HAND) quality = AttributeProperty(3) @@ -217,7 +181,7 @@ class EvAdventureWeapon(EvAdventureObject): damage_roll = AttributeProperty("1d6") -class EvAdventureRunestone(EvAdventureWeapon): +class EvAdventureRunestone(EvAdventureWeapon, EvAdventureConsumable): """ Base class for magic runestones. In _Knave_, every spell is represented by a rune stone that takes up an inventory slot. It is wielded as a weapon in order to create the specific @@ -226,14 +190,23 @@ class EvAdventureRunestone(EvAdventureWeapon): """ - obj_type = (ObjType.WEAPON.value, ObjType.MAGIC.value) - inventory_use_slot = AttributeProperty(WieldLocation.TWO_HANDS) + obj_type = (ObjType.WEAPON, ObjType.MAGIC) + inventory_use_slot = WieldLocation.TWO_HANDS quality = AttributeProperty(3) attack_type = AttributeProperty(Ability.INT) defense_type = AttributeProperty(Ability.DEX) damage_roll = AttributeProperty("1d8") + def at_post_use(self, user, *args, **kwargs): + """Called after the spell was cast""" + self.uses -= 1 + # the rune stone is not deleted after use, but + # it needs to be refreshed after resting. + + def refresh(self): + self.uses = 1 + class EvAdventureArmor(EvAdventureObject): """ @@ -241,9 +214,10 @@ class EvAdventureArmor(EvAdventureObject): """ - obj_type = ObjType.ARMOR.value - inventory_use_slot = AttributeProperty(WieldLocation.BODY) - armor = AttributeProperty(11) + obj_type = ObjType.ARMOR + inventory_use_slot = WieldLocation.BODY + + armor = AttributeProperty(1) quality = AttributeProperty(3) @@ -253,9 +227,8 @@ class EvAdventureShield(EvAdventureArmor): """ - obj_type = ObjType.SHIELD.value - inventory_use_slot = AttributeProperty(WieldLocation.SHIELD_HAND) - armor = AttributeProperty(1) + obj_type = ObjType.SHIELD + inventory_use_slot = WieldLocation.SHIELD_HAND class EvAdventureHelmet(EvAdventureArmor): @@ -264,6 +237,5 @@ class EvAdventureHelmet(EvAdventureArmor): """ - obj_type = ObjType.HELMET.value - inventory_use_slot = AttributeProperty(WieldLocation.HEAD) - armor = AttributeProperty(1) + obj_type = ObjType.HELMET + inventory_use_slot = WieldLocation.HEAD diff --git a/evennia/contrib/tutorials/evadventure/rules.py b/evennia/contrib/tutorials/evadventure/rules.py index 17f1e2753e..46b90a8ec7 100644 --- a/evennia/contrib/tutorials/evadventure/rules.py +++ b/evennia/contrib/tutorials/evadventure/rules.py @@ -289,18 +289,6 @@ class EvAdventureRollEngine: """ return self.roll("2d6") <= defender.morale - def heal(self, character, amount): - """ - Heal specific amount, but not more than our max. - - Args: - character (EvAdventureCharacter): The character to heal - amount (int): How many HP to heal. - - """ - damage = character.hp_max - character.hp - character.hp += min(damage, amount) - def heal_from_rest(self, character): """ A meal and a full night's rest allow for regaining 1d8 + Const bonus HP. @@ -312,7 +300,7 @@ class EvAdventureRollEngine: int: How much HP was healed. This is never more than how damaged we are. """ - self.heal(character, self.roll("1d8") + character.constitution) + character.heal(self.roll("1d8") + character.constitution) death_map = { "weakened": "strength", diff --git a/evennia/contrib/tutorials/evadventure/tests/test_characters.py b/evennia/contrib/tutorials/evadventure/tests/test_characters.py new file mode 100644 index 0000000000..d8ed026939 --- /dev/null +++ b/evennia/contrib/tutorials/evadventure/tests/test_characters.py @@ -0,0 +1,46 @@ +""" +Test characters. + +""" + +from evennia.utils import create +from evennia.utils.test_resources import BaseEvenniaTest + +from ..characters import EvAdventureCharacter + + +class TestCharacters(BaseEvenniaTest): + def setUp(self): + super().setUp() + self.character = create.create_object(EvAdventureCharacter, key="testchar") + + def test_abilities(self): + self.character.strength += 2 + self.assertEqual(self.character.strength, 3) + + def test_heal(self): + """Make sure we don't heal too much""" + self.character.hp = 0 + self.character.hp_max = 8 + + self.character.heal(1) + self.assertEqual(self.character.hp, 1) + self.character.heal(100) + self.assertEqual(self.character.hp, 8) + + def test_at_damage(self): + self.character.hp = 8 + self.character.at_damage(5) + self.assertEqual(self.character.hp, 3) + + def test_at_pay(self): + self.character.coins = 100 + + result = self.character.at_pay(60) + self.assertEqual(result, 60) + self.assertEqual(self.character.coins, 40) + + # can't get more coins than we have + result = self.character.at_pay(100) + self.assertEqual(result, 40) + self.assertEqual(self.characer.coins, 0)