Interface IProtocolTileDescriptor

Interface for tile descriptors, which are per protocol.

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

Methods

| Improve this Doc View Source

DescribeTileForPlayer(IPlayer, ITile, out ISet<UInt32>, out ISet<UInt32>)

Gets the description segments of a tile as seen by the given player.

Declaration
IEnumerable<MapDescriptionSegment> DescribeTileForPlayer(IPlayer player, ITile tile, out ISet<uint> creatureIdsToLearn, out ISet<uint> creatureIdsToForget)
Parameters
Type Name Description
IPlayer player

The player for which the tile is being described.
ITile tile

The tile being described.
System.Collections.Generic.ISet<System.UInt32> creatureIdsToLearn

A set of ids of creatures to learn if this description is sent.
System.Collections.Generic.ISet<System.UInt32> creatureIdsToForget

A set of ids of creatures to forget if this description is sent.
Returns
Type Description
System.Collections.Generic.IEnumerable<MapDescriptionSegment>

A collection of description segments from the tile.

Extension Methods