BlueMapWrapper

Back to README.md

Collections

• Collection
• MarkerCollection
• PlayerCollection

Collection

class BlueMapWrapper.Collection

Contains a MarkerCollection and PlayerCollection Object

Used when a simultaneous marker and player request is made

Attributes

• marker_collection
• player_collection

Attributes

marker_collection (MarkerCollection)

a MarkerCollection Object

player_collection (PlayerCollection)

a PlayerCollection Object

MarkerCollection

class bluemap_wrapper.MarkerCollection

Contains a list of MarkerSet Objects

This class is also Iterable on its own

Attributes

• marker_sets
• length

Methods

• from_key()

Attributes

marker_sets (list[MarkerSet])

A list of MarkerSet Objects

length (int)

The amount of MarkerSet Objects in marker_sets

Methods

from_key(key)

Get a MarkerSet from marker_sets by its name

Parameters

• key (str): The name of the MarkerSet, a key from bluemap_wrapper.KEYS can be used, or a custom one can be entered

  Returns:

  Returns a Requested MarkerSet

  Return Type:

  Union[MarkerSet, None]

PlayerCollection

class bluemap_wrapper.PlayerCollection

Contains a list of Player Objects

This class is also Iterable on its own

Attributes

• players
• length

Methods

• is_foreign()
• not_foreign
• from_uuid()
• from_name()

Attributes

players (list[Player])

A list of Player Objects

length (int)

The amount of Player Objects in players

Methods

is_foreign()

Get a list of players who have the foreign attribute (not in the world requested)

Returns:

A list of Player Objects that are foreign

Return Type:

list(Union[Player, None])

not_foreign()

Get a list of players who do not have the foreign attribute (in the world requested)

Returns:

A list of Player Objects that are not foreign

Return Type:

list(Union[Player, None])

from_uuid(uuid)

Get a Player Object by uuid

Parameters

• uuid (str): The UUID of the Player, the UUID must be exact with “-“ in it

  Returns:

  a Player object with the requested UUID

  Return Type:

  Union[Player, None]

from_name(name)

Get a Player Object from its Name

Parameters

• name (str): The name of the Player

  Returns:

  a Player object with the requested name

  Return Type:

  Union[Player, None]

This site is open source. Improve this page.