Class LandClaim

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

[ProtoContract]
public class LandClaim

Inheritance

object

LandClaim

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Fields

AllowUseEveryone

[ProtoMember(11)]
public bool AllowUseEveryone

Field Value

bool

Areas

[ProtoMember(1)]
public List<Cuboidi> Areas

Field Value

List<Cuboidi>

Description

[ProtoMember(7)]
public string Description

Field Value

string

LastKnownOwnerName

[ProtoMember(6)]
public string LastKnownOwnerName

Field Value

string

OwnedByEntityId

[ProtoMember(3)]
public long OwnedByEntityId

Field Value

long

OwnedByPlayerGroupUid

[ProtoMember(5)]
public uint OwnedByPlayerGroupUid

Field Value

uint

OwnedByPlayerUid

[ProtoMember(4)]
public string OwnedByPlayerUid

Field Value

string

PermittedPlayerGroupIds

Other groups allowed to use this land

[ProtoMember(8)]
public Dictionary<int, EnumBlockAccessFlags> PermittedPlayerGroupIds

Field Value

Dictionary<int, EnumBlockAccessFlags>

PermittedPlayerLastKnownPlayerName

Other players allowed to use this land, name of the player at the time the privilege was granted

[ProtoMember(10)]
public Dictionary<string, string> PermittedPlayerLastKnownPlayerName

Field Value

Dictionary<string, string>

PermittedPlayerUids

Other players allowed to use this land

[ProtoMember(9)]
public Dictionary<string, EnumBlockAccessFlags> PermittedPlayerUids

Field Value

Dictionary<string, EnumBlockAccessFlags>

ProtectionLevel

[ProtoMember(2)]
public int ProtectionLevel

Field Value

int

Properties

Center

public BlockPos Center { get; }

Property Value

BlockPos

SizeXYZ

public int SizeXYZ { get; }

Property Value

int

SizeXZ

public int SizeXZ { get; }

Property Value

int

Methods

AddArea(Cuboidi)

public EnumClaimError AddArea(Cuboidi cuboidi)

Parameters

cuboidi Cuboidi

Returns

EnumClaimError

Clone()

public LandClaim Clone()

Returns

LandClaim

CreateClaim(string, int)

public static LandClaim CreateClaim(string ownerName, int protectionLevel = 1)

Parameters

ownerName string

protectionLevel int

Returns

LandClaim

CreateClaim(EntityAgent, int)

public static LandClaim CreateClaim(EntityAgent entity, int protectionLevel = 1)

Parameters

entity EntityAgent

protectionLevel int

Returns

LandClaim

CreateClaim(IPlayer, int)

public static LandClaim CreateClaim(IPlayer player, int protectionLevel = 1)

Parameters

player IPlayer

protectionLevel int

Returns

LandClaim

Intersects(Cuboidi)

public bool Intersects(Cuboidi cuboidi)

Parameters

cuboidi Cuboidi

Returns

bool

Intersects2d(HorRectanglei)

Ignores y-values

public bool Intersects2d(HorRectanglei rec)

Parameters

rec HorRectanglei

Returns

bool

PositionInside(BlockPos)

public bool PositionInside(BlockPos position)

Parameters

position BlockPos

Returns

bool

PositionInside(Vec3d)

public bool PositionInside(Vec3d position)

Parameters

position Vec3d

Returns

bool

TestPlayerAccess(IPlayer, EnumBlockAccessFlags)

public EnumPlayerAccessResult TestPlayerAccess(IPlayer player, EnumBlockAccessFlags claimFlag)

Parameters

player IPlayer

claimFlag EnumBlockAccessFlags

Returns

EnumPlayerAccessResult