evennia.contrib.game_systems.storage.storage

class evennia.contrib.game_systems.storage.storage.StorageCommand(**kwargs)

Bases: MuxCommand

Shared functionality for storage-related commands

at_pre_cmd()

Check if the current location is tagged as a storage location Every stored object is tagged on storage, and untagged on retrieval

Returns:

bool – True if the command is to be stopped here

aliases = []

help_category = 'general'

key = 'command'

lock_storage = 'cmd:all();'

search_index_entry = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': '\nShared functionality for storage-related commands\n'}

class evennia.contrib.game_systems.storage.storage.CmdStore(**kwargs)

Bases: StorageCommand

Store something in a storage location.

Usage:

store <obj>

key = 'store'

locks = 'cmd:all()'

help_category = 'storage'

func()

Find the item in question to store, then store it

aliases = []

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': '', 'category': 'storage', 'key': 'store', 'no_prefix': ' ', 'tags': '', 'text': '\nStore something in a storage location.\n\nUsage:\n  store <obj>\n'}

class evennia.contrib.game_systems.storage.storage.CmdRetrieve(**kwargs)

Bases: StorageCommand

Retrieve something from a storage location.

Usage:

retrieve <obj>

key = 'retrieve'

locks = 'cmd:all()'

help_category = 'storage'

func()

Retrieve the item in question if possible

aliases = []

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': '', 'category': 'storage', 'key': 'retrieve', 'no_prefix': ' ', 'tags': '', 'text': '\nRetrieve something from a storage location.\n\nUsage:\n  retrieve <obj>\n'}

class evennia.contrib.game_systems.storage.storage.CmdList(**kwargs)

Bases: StorageCommand

List items in the storage location.

Usage:

list

key = 'list'

locks = 'cmd:all()'

help_category = 'storage'

func()

List items in the storage

aliases = []

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': '', 'category': 'storage', 'key': 'list', 'no_prefix': ' ', 'tags': '', 'text': '\nList items in the storage location.\n\nUsage:\n  list\n'}

class evennia.contrib.game_systems.storage.storage.CmdStorage(**kwargs)

Bases: MuxCommand

Make the current location a storage room, or delete it as a storage and move all stored objects into the room contents.

Shared storage locations can be used by all interchangeably.

The default storage identifier will be its primary key in the database, but you can supply a new one in case you want linked storages.

Usage:

storage [= [storage identifier]] storage/shared [= [storage identifier]] storage/delete

key = '@storage'

locks = 'cmd:perm(Builder)'

func()

Set the storage location.

aliases = []

help_category = 'general'

lock_storage = 'cmd:perm(Builder)'

search_index_entry = {'aliases': '', 'category': 'general', 'key': '@storage', 'no_prefix': 'storage ', 'tags': '', 'text': '\nMake the current location a storage room, or delete it as a storage and move all stored objects into the room contents.\n\nShared storage locations can be used by all interchangeably.\n\nThe default storage identifier will be its primary key in the database, but you can supply a new one in case you want linked storages.\n\nUsage:\n  storage [= [storage identifier]]\n  storage/shared [= [storage identifier]]\n  storage/delete\n'}

class evennia.contrib.game_systems.storage.storage.StorageCmdSet(cmdsetobj=None, key=None)

Bases: CmdSet

CmdSet for all storage-related commands

at_cmdset_creation()

Hook method - this should be overloaded in the inheriting class, and should take care of populating the cmdset by use of self.add().

path = 'evennia.contrib.game_systems.storage.storage.StorageCmdSet'