Class AreaOfEffectMode

Base class for all AOE modes.

Inheritance
System.Object
AreaOfEffectMode
Cone
MultiBlock
SingleBlock
Namespace: Eco.Gameplay.Items
Assembly: Eco.Gameplay.dll
Syntax
public abstract class AreaOfEffectMode : Object

Constructors

AreaOfEffectMode(Boolean)

Declaration
protected AreaOfEffectMode(bool requireCentralBlock)
Parameters
Type Name Description
System.Boolean requireCentralBlock

Set to true to ignore all blocks if central block doesn't meet the condition.

Fields

requireCentralBlock

Set to true to ignore all blocks if central block doesn't meet the condition.

Declaration
protected readonly bool requireCentralBlock
Field Value
Type Description
System.Boolean

Methods

GetAffectedBlocks(Player, Vector3i, IEnumerable<Tag>, IEnumerable<Tag>, IEnumerable<Tag>)

Gets positions of all blocks affected by a tool during an interaction or an empty enumerable if no blocks are affected.

Declaration
public abstract IEnumerable<Vector3i> GetAffectedBlocks(Player player, Vector3i centerPos, IEnumerable<Tag> tagsTargetable, IEnumerable<Tag> mustHaveTags = null, IEnumerable<Tag> mustNotHaveTags = null)
Parameters
Type Name Description
Player player

Player who is using the tool.
Vector3i centerPos

Position of the block player interacted with.
System.Collections.Generic.IEnumerable<Tag> tagsTargetable

Only blocks that have any of these tags can be affected by this interaction.
System.Collections.Generic.IEnumerable<Tag> mustHaveTags

Only blocks that have all of these tags can be affected by this interaction.
System.Collections.Generic.IEnumerable<Tag> mustNotHaveTags

Only blocks that don't have any of these tags can be affected by this interaction.
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector3i>

Extension Methods