Back to bricks list
Introduction
Technical Documentation
Other Classes
EntityNavigator
Version

EntityNavigator

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def getitem(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

Functions

__INIT__

Initialize self. See help(type(self)) for accurate signature.

Parameters:
NameTypeDefault valueDescription
entitiesUnion
DELETE_PROPAGATED_TAGS
Parameters:
NameTypeDefault valueDescription
tagsList
entity_tags_cacheDict
GET_AS_NAV_SET
Return type:
NavigableEntitySet
GET_ENTITIES_AS_SET
Return type:
Set
GET_ENTITIES_LIST
Return type:
List
GET_FIRST_ENTITY
Return type:
Optional
GET_NEXT_ENTITIES

Return all the entities that are linked to the current entities

Parameters:
NameTypeDefault valueDescription
requested_entitiesList [description] [entitytype]
Return type:
NavigableEntitySet
GET_NEXT_ENTITIES_RECURSIVE

Return all the entities that are linked to the current entities

Parameters:
NameTypeDefault valueDescription
requested_entitiesList [description] [entitytype]
include_current_entitiesbool False
Return type:
NavigableEntitySet
GET_NEXT_NOTES
Return type:
EntityNavigatorNote
GET_NEXT_RESOURCES
Return type:
EntityNavigatorResource
GET_NEXT_SCENARIOS
Return type:
EntityNavigatorScenario
GET_NEXT_VIEWS
Return type:
EntityNavigatorView
GET_PREVIOUS_ENTITIES_RECURSIVE

Return all the entities that are linked to the current entities

Parameters:
NameTypeDefault valueDescription
requested_entitiesList [description] [entitytype]
include_current_entitiesbool False
Return type:
NavigableEntitySet
GET_PREVIOUS_NOTES
Return type:
EntityNavigatorNote
GET_PREVIOUS_RESOURCES
Return type:
EntityNavigatorResource
GET_PREVIOUS_SCENARIOS
Return type:
EntityNavigatorScenario
GET_PREVIOUS_VIEWS
Return type:
EntityNavigatorView
HAS_ENTITIES
Return type:
bool
HAS_NEXT_ENTITIES
Parameters:
NameTypeDefault valueDescription
requested_entitiesList
Return type:
bool
IS_EMPTY
Return type:
bool
PROPAGATE_TAGS
Parameters:
NameTypeDefault valueDescription
tagsList
entity_tags_cacheDict
FROM_ENTITY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
entity_typeEntityType
entity_idstr
Return type:
EntityNavigator