evennia.help

This sub-package defines the help system of Evennia. It is pretty simple, mainly consisting of a database model to hold help entries. The auto-cmd-help is rather handled by the default ‘help’ command itself.

• evennia.help.filehelp
  • FileHelpEntry
    • FileHelpEntry.key
    • FileHelpEntry.aliases
    • FileHelpEntry.help_category
    • FileHelpEntry.entrytext
    • FileHelpEntry.lock_storage
    • FileHelpEntry.search_index_entry
    • FileHelpEntry.locks
    • FileHelpEntry.web_get_detail_url()
    • FileHelpEntry.web_get_admin_url()
    • FileHelpEntry.access()
    • FileHelpEntry.__init__()
  • FileHelpStorageHandler
    • FileHelpStorageHandler.__init__()
    • FileHelpStorageHandler.load()
    • FileHelpStorageHandler.all()
• evennia.help.manager
  • HelpEntryManager
    • HelpEntryManager.find_topicmatch()
    • HelpEntryManager.find_apropos()
    • HelpEntryManager.find_topicsuggestions()
    • HelpEntryManager.find_topics_with_category()
    • HelpEntryManager.get_all_topics()
    • HelpEntryManager.get_all_categories()
    • HelpEntryManager.all_to_category()
    • HelpEntryManager.search_help()
    • HelpEntryManager.create_help()
  • IntegrityError
  • TypedObjectManager
    • TypedObjectManager.create_tag()
    • TypedObjectManager.dbref()
    • TypedObjectManager.dbref_search()
    • TypedObjectManager.get_alias()
    • TypedObjectManager.get_attribute()
    • TypedObjectManager.get_by_alias()
    • TypedObjectManager.get_by_attribute()
    • TypedObjectManager.get_by_nick()
    • TypedObjectManager.get_by_permission()
    • TypedObjectManager.get_by_tag()
    • TypedObjectManager.get_dbref_range()
    • TypedObjectManager.get_id()
    • TypedObjectManager.get_nick()
    • TypedObjectManager.get_permission()
    • TypedObjectManager.get_tag()
    • TypedObjectManager.get_typeclass_totals()
    • TypedObjectManager.object_totals()
    • TypedObjectManager.search_dbref()
    • TypedObjectManager.typeclass_search()
  • make_iter()
• evennia.help.models
  • HelpEntry
    • HelpEntry.db_key
    • HelpEntry.db_help_category
    • HelpEntry.db_entrytext
    • HelpEntry.db_lock_storage
    • HelpEntry.db_tags
    • HelpEntry.db_date_created
    • HelpEntry.objects
    • HelpEntry.locks
    • HelpEntry.tags
    • HelpEntry.aliases
    • HelpEntry.date_created
    • HelpEntry.access()
    • HelpEntry.search_index_entry
    • HelpEntry.web_get_admin_url()
    • HelpEntry.web_get_create_url()
    • HelpEntry.web_get_detail_url()
    • HelpEntry.web_get_update_url()
    • HelpEntry.web_get_delete_url()
    • HelpEntry.get_absolute_url()
    • HelpEntry.DoesNotExist
    • HelpEntry.MultipleObjectsReturned
    • HelpEntry.entrytext
    • HelpEntry.get_next_by_db_date_created()
    • HelpEntry.get_previous_by_db_date_created()
    • HelpEntry.help_category
    • HelpEntry.id
    • HelpEntry.key
    • HelpEntry.lock_storage
    • HelpEntry.path
    • HelpEntry.typename
  • AliasHandler
  • ContentType
    • ContentType.DoesNotExist
    • ContentType.MultipleObjectsReturned
    • ContentType.app_label
    • ContentType.app_labeled_name
    • ContentType.get_all_objects_for_this_type()
    • ContentType.get_object_for_this_type()
    • ContentType.id
    • ContentType.logentry_set
    • ContentType.model
    • ContentType.model_class()
    • ContentType.name
    • ContentType.natural_key()
    • ContentType.objects
    • ContentType.permission_set
  • HelpEntryManager
    • HelpEntryManager.all_to_category()
    • HelpEntryManager.create_help()
    • HelpEntryManager.find_apropos()
    • HelpEntryManager.find_topicmatch()
    • HelpEntryManager.find_topics_with_category()
    • HelpEntryManager.find_topicsuggestions()
    • HelpEntryManager.get_all_categories()
    • HelpEntryManager.get_all_topics()
    • HelpEntryManager.search_help()
  • LockHandler
    • LockHandler.__init__()
    • LockHandler.add()
    • LockHandler.all()
    • LockHandler.append()
    • LockHandler.cache_lock_bypass()
    • LockHandler.check()
    • LockHandler.check_lockstring()
    • LockHandler.clear()
    • LockHandler.delete()
    • LockHandler.get()
    • LockHandler.remove()
    • LockHandler.replace()
    • LockHandler.reset()
    • LockHandler.validate()
  • SharedMemoryModel
    • SharedMemoryModel.Meta
      • SharedMemoryModel.Meta.abstract
    • SharedMemoryModel.at_idmapper_flush()
    • SharedMemoryModel.cache_instance()
    • SharedMemoryModel.delete()
    • SharedMemoryModel.flush_cached_instance()
    • SharedMemoryModel.flush_from_cache()
    • SharedMemoryModel.flush_instance_cache()
    • SharedMemoryModel.get_all_cached_instances()
    • SharedMemoryModel.get_cached_instance()
    • SharedMemoryModel.objects
    • SharedMemoryModel.path
    • SharedMemoryModel.save()
    • SharedMemoryModel.typename
  • Tag
    • Tag.DoesNotExist
    • Tag.MultipleObjectsReturned
    • Tag.accountdb_set
    • Tag.channeldb_set
    • Tag.db_category
    • Tag.db_data
    • Tag.db_key
    • Tag.db_model
    • Tag.db_tagtype
    • Tag.helpentry_set
    • Tag.id
    • Tag.msg_set
    • Tag.objectdb_set
    • Tag.objects
    • Tag.scriptdb_set
  • TagHandler
    • TagHandler.__init__()
    • TagHandler.add()
    • TagHandler.all()
    • TagHandler.batch_add()
    • TagHandler.batch_remove()
    • TagHandler.clear()
    • TagHandler.get()
    • TagHandler.has()
    • TagHandler.remove()
    • TagHandler.reset_cache()
  • lazy_property
    • lazy_property.__init__()
  • reverse()
  • slugify()
• evennia.help.utils
  • wildcard_stemmer()
  • LunrSearch
    • LunrSearch.index()
  • help_search_with_index()
  • parse_entry_for_subcategories()