Interface IMapDescriptor

Interface for map descriptors.

Namespace: Fibula.Map.Contracts.Abstractions
Assembly: Fibula.Map.Contracts.dll
Syntax
public interface IMapDescriptor

Fields

| Improve this Doc View Source

CreatureIdsToForgetMetadataKeyName

The key name for the metadata element returned for those ids of creatures to forget.

Declaration
public const string CreatureIdsToForgetMetadataKeyName = "CreatureIdsToForget"
Field Value
Type Description
System.String
| Improve this Doc View Source

CreatureIdsToLearnMetadataKeyName

The key name for the metadata element returned for those ids of creatures to learn.

Declaration
public const string CreatureIdsToLearnMetadataKeyName = "CreatureIdsToLearn"
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

DescribeAt(IPlayer, Location)

Gets the description bytes of the map on behalf of a given player at a given location.

Declaration
(IDictionary<string, object> descriptionMetadata, ReadOnlySequence<byte> descriptionData) DescribeAt(IPlayer player, Location location)
Parameters
Type Name Description
IPlayer player

The player for which the description is being retrieved for.
Location location

The center location from which the description is being retrieved.
Returns
Type Description
System.ValueTuple<System.Collections.Generic.IDictionary<System.String, System.Object>, System.Buffers.ReadOnlySequence<System.Byte>>

A tuple containing the description metadata: a map of string to objects, and the description data: a sequence of bytes representing the description.
| Improve this Doc View Source

DescribeTile(IPlayer, Location)

Gets the description bytes of a single tile of the map in behalf of a given player at a given location.

Declaration
(IDictionary<string, object> descriptionMetadata, ReadOnlySequence<byte> descriptionData) DescribeTile(IPlayer player, Location location)
Parameters
Type Name Description
IPlayer player

The player for which the description is being retrieved for.
Location location

The location from which the description of the tile is being retrieved.
Returns
Type Description
System.ValueTuple<System.Collections.Generic.IDictionary<System.String, System.Object>, System.Buffers.ReadOnlySequence<System.Byte>>

A tuple containing the description metadata: a map of string to objects, and the description data: a sequence of bytes representing the tile's description.
| Improve this Doc View Source

DescribeWindow(IPlayer, UInt16, UInt16, SByte, SByte, Byte, Byte, SByte)

Gets the description bytes of the map on behalf of a given player for the specified window.

Declaration
(IDictionary<string, object> descriptionMetadata, ReadOnlySequence<byte> descriptionData) DescribeWindow(IPlayer player, ushort startX, ushort startY, sbyte startZ, sbyte endZ, byte windowSizeX = 18, byte windowSizeY = 14, sbyte startingZOffset = 0)
Parameters
Type Name Description
IPlayer player

The player for which the description is being retrieved for.
System.UInt16 startX

The starting X coordinate of the window.
System.UInt16 startY

The starting Y coordinate of the window.
System.SByte startZ

The starting Z coordinate of the window.
System.SByte endZ

The ending Z coordinate of the window.
System.Byte windowSizeX

The size of the window in X.
System.Byte windowSizeY

The size of the window in Y.
System.SByte startingZOffset

Optional. A starting offset for Z.
Returns
Type Description
System.ValueTuple<System.Collections.Generic.IDictionary<System.String, System.Object>, System.Buffers.ReadOnlySequence<System.Byte>>

A tuple containing the description metadata: a map of string to objects, and the description data: a sequence of bytes representing the description.

Extension Methods