Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-29 12:07:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

minor docs update

Browse source
This commit is contained in:
InspectorCaracal 2023-03-08 19:42:31 -07:00
parent 0264e53621
commit be652ed8f1
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
evennia/contrib/game_systems/containers/README.md
View file

@ -24,7 +24,7 @@ This will replace the default `look` and `get` commands with the container-frien
The contrib includes a `ContainerObject` typeclass which has all of the set-up necessary to be used as a container. To use, all you need to do is create an object in-game with that typeclass - it will automatically inherit anything you implemented in your base Object typeclass as well.
create bag:evennia.contrib.game_systems.containers.ContainerObject
create bag:game_systems.containers.ContainerObject
To make any other objects usable as containers, all you need to do is set the `get_from` lock type on it.
@ -40,6 +40,6 @@ The `ContainerObject` class is intended to be usable as-is, but you can also inh
### `at_pre_get_from` and `at_pre_put_in` methods
These two methods on `ContainerObject` are called as extra checks when attempting to either get an object from, or put an object in, a container. The contrib's `Container.at_pre_get_from` doesn't do any additional validation by default, while `ContainerObject.at_pre_put_in` does a simple capacity check.
These two methods on `ContainerObject` are called as extra checks when attempting to either get an object from, or put an object in, a container. The contrib's `ContainerObject.at_pre_get_from` doesn't do any additional validation by default, while `ContainerObject.at_pre_put_in` does a simple capacity check.
You can override these methods on your own child class to do any additional capacity or access checks.