Class SettlementCommands

Inheritance

System.Object

SettlementCommands

Namespace: Eco.Gameplay.Settlements

Assembly: Eco.Gameplay.dll

Syntax

[ChatCommandHandler]
public static class SettlementCommands : Object

Methods

AddClaimPapers(User, Int32, Settlement)

Declaration

[ChatSubCommand]
public static void AddClaimPapers(User user, int quantity, Settlement settlement)

Parameters

Type	Name	Description
User	user
System.Int32	quantity
Settlement	settlement

AddClaimStakes(User, Int32, Settlement)

Declaration

[ChatSubCommand]
public static void AddClaimStakes(User user, int quantity, Settlement settlement)

Parameters

Type	Name	Description
User	user
System.Int32	quantity
Settlement	settlement

AllowAdminAnnex(IChatClient, Boolean)

Declaration

[ChatSubCommand]
public static void AllowAdminAnnex(IChatClient client, bool ignore = true)

Parameters

Type	Name	Description
IChatClient	client
System.Boolean	ignore

Annex(IChatClient, Settlement, Settlement)

Declaration

[ChatSubCommand]
public static void Annex(IChatClient client, Settlement source, Settlement target)

Parameters

Type	Name	Description
IChatClient	client
Settlement	source
Settlement	target

CivicPowers(User, Boolean)

Declaration

[ChatSubCommand]
public static void CivicPowers(User user, bool settlementsWhereYoureACitizenOnly = true)

Parameters

Type	Name	Description
User	user
System.Boolean	settlementsWhereYoureACitizenOnly

Emigrate(User, Settlement, User)

Declaration

[ChatSubCommand]
public static void Emigrate(User user, Settlement target, User citizen)

Parameters

Type	Name	Description
User	user
Settlement	target
User	citizen

EmigrateAll(User, Settlement)

Declaration

[ChatSubCommand]
public static void EmigrateAll(User user, Settlement target = null)

Parameters

Type	Name	Description
User	user
Settlement	target

EnableDisable(User, Settlement, Boolean)

Declaration

[ChatSubCommand]
public static void EnableDisable(User user, Settlement set, bool enabled)

Parameters

Type	Name	Description
User	user
Settlement	set
System.Boolean	enabled

ForceRenounceCitizenship(User, User)

Declaration

[ChatSubCommand]
public static void ForceRenounceCitizenship(User user, User target = null)

Parameters

Type	Name	Description
User	user
User	target

GetHomesteadBack(User)

Declaration

[ChatSubCommand]
public static void GetHomesteadBack(User user)

Parameters

Type	Name	Description
User	user

HomesteadReport(User)

Declaration

[ChatSubCommand]
public static void HomesteadReport(User user)

Parameters

Type	Name	Description
User	user

IgnoreRequirements(IChatClient, Boolean)

Declaration

[ChatSubCommand]
public static void IgnoreRequirements(IChatClient client, bool ignore = true)

Parameters

Type	Name	Description
IChatClient	client
System.Boolean	ignore

PlaceHomestead(User, Boolean, Boolean, Boolean)

Declaration

[ChatSubCommand]
public static void PlaceHomestead(User user, bool self = false, bool addAsCitizen = false, bool abandoned = false)

Parameters

Type	Name	Description
User	user
System.Boolean	self
System.Boolean	addAsCitizen
System.Boolean	abandoned

Populate(User, Settlement, Int32, Int32, Int32, Boolean)

Declaration

public static void Populate(User user, Settlement settlement, int newCitizenCount = 5, int newApplicantCount = 0, int newInviteeCount = 0, bool makeAllActive = true)

Parameters

Type	Name	Description
User	user
Settlement	settlement
System.Int32	newCitizenCount
System.Int32	newApplicantCount
System.Int32	newInviteeCount
System.Boolean	makeAllActive

Populate(User, Boolean, Int32, Int32, Int32, Boolean)

Declaration

[ChatSubCommand]
public static void Populate(User user, bool foundTown = true, int newCitizenCount = 5, int newApplicantCount = 2, int newInviteeCount = 2, bool makeAllActive = true)

Parameters

Type	Name	Description
User	user
System.Boolean	foundTown
System.Int32	newCitizenCount
System.Int32	newApplicantCount
System.Int32	newInviteeCount
System.Boolean	makeAllActive

RebuildCivicPowers(User)

Declaration

[ChatSubCommand]
public static void RebuildCivicPowers(User user)

Parameters

Type	Name	Description
User	user

RecountClaims(User, Settlement)

Declaration

[ChatSubCommand]
public static void RecountClaims(User user, Settlement settlement = null)

Parameters

Type	Name	Description
User	user
Settlement	settlement

RenounceCitizenship(User)

Declaration

[ChatSubCommand]
public static void RenounceCitizenship(User user)

Parameters

Type	Name	Description
User	user

Reset(User, Settlement, Boolean)

Declaration

[ChatSubCommand]
public static void Reset(User user, Settlement set, bool forceAllDefaults = false)

Parameters

Type	Name	Description
User	user
Settlement	set
System.Boolean	forceAllDefaults

ResolveCrisis(User, Settlement)

Declaration

[ChatSubCommand]
public static void ResolveCrisis(User user, Settlement settlement = null)

Parameters

Type	Name	Description
User	user
Settlement	settlement

Settlement(User)

Declaration

[ChatCommand]
public static void Settlement(User user)

Parameters

Type	Name	Description
User	user

SettlementReport(User, Int32)

Declaration

[ChatSubCommand]
public static void SettlementReport(User user, int tier)

Parameters

Type	Name	Description
User	user
System.Int32	tier

SpawnHomestead(User, Boolean, User)

Declaration

[ChatSubCommand]
public static void SpawnHomestead(User user, bool makeCitizen = false, User homesteadOwner = null)

Parameters

Type	Name	Description
User	user
System.Boolean	makeCitizen
User	homesteadOwner

SpawnSimpleSettlements(User, Boolean, Boolean)

Declaration

[ChatSubCommand]
public static void SpawnSimpleSettlements(User user, bool makeSelfLeaderAndCitizen = true, bool assignTaxes = true)

Parameters

Type	Name	Description
User	user
System.Boolean	makeSelfLeaderAndCitizen
System.Boolean	assignTaxes

SpawnTown(User, Boolean, Boolean, Int32, Int32, Int32, Int32)

Declaration

[ChatSubCommand]
public static void SpawnTown(User user, bool foundTown = true, bool makeSelfCitizenAndMayor = true, int newCitizenCount = 5, int newApplicantCount = 2, int newInviteeCount = 2, int boostCulture = 1000)

Parameters

Type	Name	Description
User	user
System.Boolean	foundTown
System.Boolean	makeSelfCitizenAndMayor
System.Int32	newCitizenCount
System.Int32	newApplicantCount
System.Int32	newInviteeCount
System.Int32	boostCulture

Vacate(User, Settlement, User)

Declaration

[ChatSubCommand]
public static void Vacate(User user, Settlement target, User citizen)

Parameters

Type	Name	Description
User	user
Settlement	target
User	citizen

VacateAll(User, Settlement)

Declaration

[ChatSubCommand]
public static void VacateAll(User user, Settlement target = null)

Parameters

Type	Name	Description
User	user
Settlement	target