Class DecalSystem

Inheritance
System.Object
SharedDecalSystem
DecalSystem
Namespace: Content.Server.Decals
Assembly: Content.Server.dll
Syntax
public sealed class DecalSystem : SharedDecalSystem

Methods

| Improve this Doc View Source

DirtyChunk(EntityUid, Vector2i, DecalGridComponent.DecalChunk)

Declaration
protected override void DirtyChunk(EntityUid uid, Vector2i chunkIndices, DecalGridComponent.DecalChunk chunk)
Parameters
Type Name Description
EntityUid uid
Vector2i chunkIndices
DecalGridComponent.DecalChunk chunk
| Improve this Doc View Source

GetDecalsInRange(EntityUid, Vector2, Single, Nullable<Func<Decal, Boolean>>)

Declaration
public HashSet<(uint Index, Decal Decal)> GetDecalsInRange(EntityUid gridId, Vector2 position, float distance = 0.75F, Func<Decal, bool>? validDelegate = null)
Parameters
Type Name Description
EntityUid gridId
Vector2 position
System.Single distance
System.Nullable<Func<Decal, System.Boolean>> validDelegate
Returns
Type Description
HashSet<System.ValueTuple<System.UInt32, Decal>>
| Improve this Doc View Source

GetDecalsIntersecting(EntityUid, Box2, DecalGridComponent)

Declaration
public HashSet<(uint Index, Decal Decal)> GetDecalsIntersecting(EntityUid gridUid, Box2 bounds, DecalGridComponent component = null)
Parameters
Type Name Description
EntityUid gridUid
Box2 bounds
DecalGridComponent component
Returns
Type Description
HashSet<System.ValueTuple<System.UInt32, Decal>>
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
Overrides
| Improve this Doc View Source

RemoveDecal(EntityUid, UInt32, DecalGridComponent)

Declaration
public bool RemoveDecal(EntityUid gridId, uint decalId, DecalGridComponent component = null)
Parameters
Type Name Description
EntityUid gridId
System.UInt32 decalId
DecalGridComponent component
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetDecalCleanable(EntityUid, UInt32, Boolean, DecalGridComponent)

Declaration
public bool SetDecalCleanable(EntityUid gridId, uint decalId, bool value, DecalGridComponent comp = null)
Parameters
Type Name Description
EntityUid gridId
System.UInt32 decalId
System.Boolean value
DecalGridComponent comp
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetDecalColor(EntityUid, UInt32, Nullable<Color>, DecalGridComponent)

Declaration
public bool SetDecalColor(EntityUid gridId, uint decalId, Color? value, DecalGridComponent comp = null)
Parameters
Type Name Description
EntityUid gridId
System.UInt32 decalId
System.Nullable<Color> value
DecalGridComponent comp
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetDecalId(EntityUid, UInt32, String, DecalGridComponent)

Declaration
public bool SetDecalId(EntityUid gridId, uint decalId, string id, DecalGridComponent comp = null)
Parameters
Type Name Description
EntityUid gridId
System.UInt32 decalId
System.String id
DecalGridComponent comp
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetDecalPosition(EntityUid, UInt32, EntityCoordinates, DecalGridComponent)

Changes a decals position. Note this will actually result in a new decal being created, possibly on a new grid or chunk.

Declaration
public bool SetDecalPosition(EntityUid gridId, uint decalId, EntityCoordinates coordinates, DecalGridComponent comp = null)
Parameters
Type Name Description
EntityUid gridId
System.UInt32 decalId
Robust.Shared.Map.EntityCoordinates coordinates
DecalGridComponent comp
Returns
Type Description
System.Boolean
Remarks

If the new position is invalid, this will result in the decal getting deleted.

| Improve this Doc View Source

SetDecalRotation(EntityUid, UInt32, Angle, DecalGridComponent)

Declaration
public bool SetDecalRotation(EntityUid gridId, uint decalId, Angle value, DecalGridComponent comp = null)
Parameters
Type Name Description
EntityUid gridId
System.UInt32 decalId
Angle value
DecalGridComponent comp
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetDecalZIndex(EntityUid, UInt32, Int32, DecalGridComponent)

Declaration
public bool SetDecalZIndex(EntityUid gridId, uint decalId, int value, DecalGridComponent comp = null)
Parameters
Type Name Description
EntityUid gridId
System.UInt32 decalId
System.Int32 value
DecalGridComponent comp
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Shutdown()

Declaration
public override void Shutdown()
| Improve this Doc View Source

TryAddDecal(Decal, EntityCoordinates, out UInt32)

Declaration
public bool TryAddDecal(Decal decal, EntityCoordinates coordinates, out uint decalId)
Parameters
Type Name Description
Decal decal
Robust.Shared.Map.EntityCoordinates coordinates
System.UInt32 decalId
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TryAddDecal(String, EntityCoordinates, out UInt32, Nullable<Color>, Nullable<Angle>, Int32, Boolean)

Declaration
public bool TryAddDecal(string id, EntityCoordinates coordinates, out uint decalId, Color? color = null, Angle? rotation = null, int zIndex = 0, bool cleanable = false)
Parameters
Type Name Description
System.String id
Robust.Shared.Map.EntityCoordinates coordinates
System.UInt32 decalId
System.Nullable<Color> color
System.Nullable<Angle> rotation
System.Int32 zIndex
System.Boolean cleanable
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime
| Improve this Doc View Source

UpdatePlayer(IPlayerSession)

Declaration
public void UpdatePlayer(IPlayerSession player)
Parameters
Type Name Description
Robust.Server.Player.IPlayerSession player