Interface ILandClaimAPI

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

public interface ILandClaimAPI

Properties

All

List of all claims on the server. Same as WorldManager.SaveGame.Claims.

List<LandClaim> All { get; }

Property Value

List<LandClaim>

Methods

Add(LandClaim)

Add a new claim.

void Add(LandClaim claim)

Parameters

claim LandClaim

Get(BlockPos)

Get all claims registered at this position

LandClaim[] Get(BlockPos pos)

Parameters

pos BlockPos

Returns

LandClaim[]

Remove(LandClaim)

Remove a claim. Returns false if no such claim was registered

bool Remove(LandClaim claim)

Parameters

claim LandClaim

Returns

bool

TestAccess(IPlayer, BlockPos, EnumBlockAccessFlags)

Checks with the permission system if given player has use or place/break permissions on supplied position. Returns always true when called on the client!

EnumWorldAccessResponse TestAccess(IPlayer player, BlockPos pos, EnumBlockAccessFlags accessFlag)

Parameters

player IPlayer

pos BlockPos

accessFlag EnumBlockAccessFlags

Returns

EnumWorldAccessResponse

TryAccess(IPlayer, BlockPos, EnumBlockAccessFlags)

Same as TestAccess(IPlayer, BlockPos, EnumBlockAccessFlags) but also sends an error message to the player and executes a MarkDirty() event the block. Returns always true when called on the client!

bool TryAccess(IPlayer player, BlockPos pos, EnumBlockAccessFlags accessFlag)

Parameters

player IPlayer

pos BlockPos

accessFlag EnumBlockAccessFlags

Returns

bool