Class TurfHelpers
Inheritance
System.Object
TurfHelpers
Assembly: Content.Shared.dll
Syntax
public static class TurfHelpers : object
Methods
|
Improve this Doc
View Source
GetContentTileDefinition(Tile, ITileDefinitionManager)
Returns the content tile definition for a tile.
Declaration
public static ContentTileDefinition GetContentTileDefinition(this Tile tile, ITileDefinitionManager tileDefinitionManager = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.Tile |
tile |
|
| Robust.Shared.Map.ITileDefinitionManager |
tileDefinitionManager |
|
Returns
|
Improve this Doc
View Source
GetContentTileDefinition(TileRef, ITileDefinitionManager)
Returns the content tile definition for a tile ref.
Declaration
public static ContentTileDefinition GetContentTileDefinition(this TileRef tile, ITileDefinitionManager tileDefinitionManager = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.TileRef |
tile |
|
| Robust.Shared.Map.ITileDefinitionManager |
tileDefinitionManager |
|
Returns
|
Improve this Doc
View Source
GetEntitiesInTile(EntityCoordinates, LookupFlags, Nullable<EntityLookupSystem>)
Helper that returns all entities in a turf.
Declaration
public static IEnumerable<EntityUid> GetEntitiesInTile(this EntityCoordinates coordinates, LookupFlags flags = null, EntityLookupSystem? lookupSystem = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.EntityCoordinates |
coordinates |
|
| LookupFlags |
flags |
|
| System.Nullable<EntityLookupSystem> |
lookupSystem |
|
Returns
| Type |
Description |
| IEnumerable<EntityUid> |
|
|
Improve this Doc
View Source
GetEntitiesInTile(TileRef, LookupFlags, Nullable<EntityLookupSystem>)
Helper that returns all entities in a turf.
Declaration
public static IEnumerable<EntityUid> GetEntitiesInTile(this TileRef turf, LookupFlags flags = null, EntityLookupSystem? lookupSystem = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.TileRef |
turf |
|
| LookupFlags |
flags |
|
| System.Nullable<EntityLookupSystem> |
lookupSystem |
|
Returns
| Type |
Description |
| IEnumerable<EntityUid> |
|
|
Improve this Doc
View Source
GetEntitiesInTile(Vector2i, EntityUid, LookupFlags, Nullable<EntityLookupSystem>)
Helper that returns all entities in a turf.
Declaration
public static IEnumerable<EntityUid> GetEntitiesInTile(this Vector2i indices, EntityUid gridId, LookupFlags flags = null, EntityLookupSystem? lookupSystem = null)
Parameters
| Type |
Name |
Description |
| Vector2i |
indices |
|
| EntityUid |
gridId |
|
| LookupFlags |
flags |
|
| System.Nullable<EntityLookupSystem> |
lookupSystem |
|
Returns
| Type |
Description |
| IEnumerable<EntityUid> |
|
|
Improve this Doc
View Source
GetTileRef(EntityCoordinates, Nullable<IEntityManager>, IMapManager)
Attempts to get the turf at a certain coordinates or null if no such turf is found.
Declaration
public static TileRef? GetTileRef(this EntityCoordinates coordinates, IEntityManager? entityManager = null, IMapManager mapManager = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.EntityCoordinates |
coordinates |
|
| System.Nullable<IEntityManager> |
entityManager |
|
| Robust.Shared.Map.IMapManager |
mapManager |
|
Returns
| Type |
Description |
| System.Nullable<Robust.Shared.Map.TileRef> |
|
|
Improve this Doc
View Source
GetTileRef(Vector2i, EntityUid, IMapManager)
Attempts to get the turf at map indices with grid id or null if no such turf is found.
Declaration
public static TileRef GetTileRef(this Vector2i vector2i, EntityUid gridId, IMapManager mapManager = null)
Parameters
| Type |
Name |
Description |
| Vector2i |
vector2i |
|
| EntityUid |
gridId |
|
| Robust.Shared.Map.IMapManager |
mapManager |
|
Returns
| Type |
Description |
| Robust.Shared.Map.TileRef |
|
|
Improve this Doc
View Source
IsBlockedTurf(TileRef, Boolean, Nullable<EntityLookupSystem>)
Checks if a turf has something dense on it.
Declaration
public static bool IsBlockedTurf(this TileRef turf, bool filterMobs, EntityLookupSystem? physics = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.TileRef |
turf |
|
| System.Boolean |
filterMobs |
|
| System.Nullable<EntityLookupSystem> |
physics |
|
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
IsSpace(Tile, ITileDefinitionManager)
Returns whether a tile is considered space.
Declaration
public static bool IsSpace(this Tile tile, ITileDefinitionManager tileDefinitionManager = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.Tile |
tile |
|
| Robust.Shared.Map.ITileDefinitionManager |
tileDefinitionManager |
|
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
IsSpace(TileRef, ITileDefinitionManager)
Returns whether a tile ref is considered space.
Declaration
public static bool IsSpace(this TileRef tile, ITileDefinitionManager tileDefinitionManager = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.TileRef |
tile |
|
| Robust.Shared.Map.ITileDefinitionManager |
tileDefinitionManager |
|
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
PickVariant(ContentTileDefinition, IRobustRandom)
Returns a weighted pick of a tile variant.
Declaration
public static byte PickVariant(this ContentTileDefinition tile, IRobustRandom random = null)
Parameters
Returns
| Type |
Description |
| System.Byte |
|
|
Improve this Doc
View Source
TryGetTileRef(EntityCoordinates, out Nullable<TileRef>, Nullable<IEntityManager>, IMapManager)
Declaration
public static bool TryGetTileRef(this EntityCoordinates coordinates, out TileRef? turf, IEntityManager? entityManager = null, IMapManager mapManager = null)
Parameters
| Type |
Name |
Description |
| Robust.Shared.Map.EntityCoordinates |
coordinates |
|
| System.Nullable<Robust.Shared.Map.TileRef> |
turf |
|
| System.Nullable<IEntityManager> |
entityManager |
|
| Robust.Shared.Map.IMapManager |
mapManager |
|
Returns
| Type |
Description |
| System.Boolean |
|