Class User

public class User : SimpleEntry, ILinkableParameterized<bool>, ILinkableParameterized<SimpleEntry.NamingOptions>, ILinkable, IValidity, ICachesValidity, IDescribable, ISuffixName, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, ITickable, IComparable, IStorage, ISerializable, IAlias, INotifyPropertyChanged, ICanTakeDamage, IObserverConversionTarget, IChatReceiver, IHasID, INamed, IReInitializable, IHasReputation, IController, IViewController, IGivesReputation, IReputationAssociated, IHasReferenceableSerializableID, IHasSerializableID, IHasUniversalID, IHasBonuses, IChatClient, INotificationReceiver

Constructors

User(Guid)

Constructor used only for creating fake users in benchmarks.

Declaration

protected User(Guid strangeId)

Parameters

Type	Name	Description
System.Guid	strangeId

User(Guid, String, String, String, IPersistent)

Declaration

public User(Guid strangeId, string steamID, string twitchID, string name, IPersistent storageHandle)

Parameters

Type	Name	Description
System.Guid	strangeId
System.String	steamID
System.String	twitchID
System.String	name
IPersistent	storageHandle

Fields

CitizenshipChangedEvent

Declaration

public readonly ThreadSafeAction CitizenshipChangedEvent

Field Value

Type	Description
ThreadSafeAction

DynamicValueContext

Declaration

public IDynamicValueContext DynamicValueContext

Field Value

Type	Description
IDynamicValueContext

ForceDemote

Set this to true to demote this user from admin to regular user until server is restarted.

Declaration

public bool ForceDemote

Field Value

Type	Description
System.Boolean

ForceDevTier

Debug field used to promote a user to server adnim with dev tieruntil server is restarted.

Declaration

public bool ForceDevTier

Field Value

Type	Description
System.Boolean

Language

Declaration

public string Language

Field Value

Type	Description
System.String

MigrateUserUIStates

Declaration

public bool MigrateUserUIStates

Field Value

Type	Description
System.Boolean

OnPickupingObject

Declaration

public readonly ThreadSafeAction<User, INetObject, INetObject, GameActionPack> OnPickupingObject

Field Value

Type	Description
ThreadSafeAction<User, INetObject, INetObject, GameActionPack>

SpecialUserPowers

Declaration

public SpecialUserPowers SpecialUserPowers

Field Value

Type	Description
SpecialUserPowers

UiStateChangedEvent

Declaration

public static readonly ThreadSafeAction<User> UiStateChangedEvent

Field Value

Type	Description
ThreadSafeAction<User>

UserUI

Declaration

public UserUI UserUI

Field Value

Type	Description
UserUI

Properties

AcceptedContracts

Declaration

public IEnumerable<Contract> AcceptedContracts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Contract>

ActiveTimeLog

Declaration

public TimeLog ActiveTimeLog { get; set; }

Property Value

Type	Description
TimeLog

AllCitizenships

Citizenship of town, and its country, and its federation, etc (if they exist).

Declaration

public IEnumerable<Settlement> AllCitizenships { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Settlement>

Avatar

Declaration

public Avatar Avatar { get; }

Property Value

Type	Description
Avatar

BadgeIcon

Declaration

public string BadgeIcon { get; }

Property Value

Type	Description
System.String

BankAccount

Declaration

public BankAccount BankAccount { get; }

Property Value

Type	Description
BankAccount

BlockHitCache

Declaration

public BlockHitCache BlockHitCache { get; set; }

Property Value

Type	Description
BlockHitCache

Bonuses

Aggregates bonuses from talents (future: settlement, clothing, etc).

Declaration

public IEnumerable<Bonus> Bonuses { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Bonus>

CachedCulture

Declaration

public CultureUserCache CachedCulture { get; set; }

Property Value

Type	Description
CultureUserCache

CalorieRateMultiplier

Declaration

public float CalorieRateMultiplier { get; set; }

Property Value

Type	Description
System.Single

CanBeDeleted

Declaration

public override bool CanBeDeleted { get; }

Property Value

Type	Description
System.Boolean

Overrides

SimpleEntry.CanBeDeleted

Carrying

Declaration

public ItemStack Carrying { get; }

Property Value

Type	Description
ItemStack

ChatRecipients

Declaration

public IEnumerable<User> ChatRecipients { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<User>

ChatTag

Declaration

public string ChatTag { get; }

Property Value

Type	Description
System.String

Client

Declaration

public INetClient Client { get; }

Property Value

Type	Description
INetClient

ClientSavedData

Declaration

public InitialData ClientSavedData { get; }

Property Value

Type	Description
InitialData

ConstantHighlightSetting

Declaration

public ConstantHighlightSetting ConstantHighlightSetting { get; set; }

Property Value

Type	Description
ConstantHighlightSetting

Currency

Declaration

public Currency Currency { get; }

Property Value

Type	Description
Currency

CurrentAtmosphere

Declaration

public Atmosphere CurrentAtmosphere { get; }

Property Value

Type	Description
Atmosphere

CurrentRoom

Declaration

public Room CurrentRoom { get; }

Property Value

Type	Description
Room

CurrentTutorialStatus

Declaration

public TutorialStatus CurrentTutorialStatus { get; set; }

Property Value

Type	Description
TutorialStatus

Debts

Declaration

public IEnumerable<Debt> Debts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Debt>

DetectionRange

Declaration

public float DetectionRange { get; }

Property Value

Type	Description
System.Single

DevToolSelected

Declaration

public bool DevToolSelected { get; }

Property Value

Type	Description
System.Boolean

DirectCitizenship

Declaration

public Settlement DirectCitizenship { get; set; }

Property Value

Type	Description
Settlement

DisplayedContracts

Declaration

public IEnumerable<Contract> DisplayedContracts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Contract>

EcoPlayFabUserData

Declaration

public EcoStrangeCloudUserData EcoPlayFabUserData { get; }

Property Value

Type	Description
EcoStrangeCloudUserData

EnteredWorld

Declaration

public bool EnteredWorld { get; }

Property Value

Type	Description
System.Boolean

ExhaustionMonitor

Declaration

public ExhaustionMonitor ExhaustionMonitor { get; }

Property Value

Type	Description
ExhaustionMonitor

FacingDir

Declaration

public Direction FacingDir { get; }

Property Value

Type	Description
Direction

FirstLogin

Declaration

public bool FirstLogin { get; }

Property Value

Type	Description
System.Boolean

GetWatchedWorkOrders

Declaration

public IEnumerable<WorkOrder> GetWatchedWorkOrders { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<WorkOrder>

HomesteadDeed

Declaration

public Deed HomesteadDeed { get; set; }

Property Value

Type	Description
Deed

ImplementationName

Declaration

public string ImplementationName { get; }

Property Value

Type	Description
System.String

IncomeAndExpenses

Declaration

public IEnumerable<RecurringTransfer> IncomeAndExpenses { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<RecurringTransfer>

Inventory

Declaration

public UserInventory Inventory { get; }

Property Value

Type	Description
UserInventory

IsAbandoned

Declaration

public bool IsAbandoned { get; }

Property Value

Type	Description
System.Boolean

IsActive

Declaration

public bool IsActive { get; }

Property Value

Type	Description
System.Boolean

IsAdmin

Declaration

public bool IsAdmin { get; }

Property Value

Type	Description
System.Boolean

IsDevTier

Ths is true only for users who have dev tier and are admins on this server.

Declaration

public bool IsDevTier { get; }

Property Value

Type	Description
System.Boolean

IsInvisible

Declaration

public bool IsInvisible { get; set; }

Property Value

Type	Description
System.Boolean

IsOnline

Declaration

public bool IsOnline { get; }

Property Value

Type	Description
System.Boolean

IsSlgDev

Declaration

public bool IsSlgDev { get; }

Property Value

Type	Description
System.Boolean

LastOnlineTime

Declaration

public double LastOnlineTime { get; }

Property Value

Type	Description
System.Double

LastTickSec

Declaration

public double LastTickSec { get; set; }

Property Value

Type	Description
System.Double

LastWastePos

Declaration

public Vector3i LastWastePos { get; set; }

Property Value

Type	Description
Vector3i

LoggedIn

Declaration

public bool LoggedIn { get; }

Property Value

Type	Description
System.Boolean

LoginTime

Declaration

public double LoginTime { get; }

Property Value

Type	Description
System.Double

LogoutTime

Declaration

public double LogoutTime { get; }

Property Value

Type	Description
System.Double

Mailbox

Declaration

public Mailbox Mailbox { get; set; }

Property Value

Type	Description
Mailbox

MarkedUpChatTag

Declaration

public string MarkedUpChatTag { get; }

Property Value

Type	Description
System.String

MarkedUpName

Declaration

public override LocString MarkedUpName { get; }

Property Value

Type	Description
LocString

Overrides

SimpleEntry.MarkedUpName

MarkedUpReputationAndName

Declaration

public string MarkedUpReputationAndName { get; }

Property Value

Type	Description
System.String

Markers

Declaration

public WorldMarkerManager Markers { get; set; }

Property Value

Type	Description
WorldMarkerManager

ModifiedStats

Declaration

public UserStats ModifiedStats { get; set; }

Property Value

Type	Description
UserStats

MyContracts

Declaration

public IEnumerable<Contract> MyContracts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Contract>

NextTick

Declaration

public double NextTick { get; set; }

Property Value

Type	Description
System.Double

OfflineInfo

Declaration

public OfflineInfo OfflineInfo { get; set; }

Property Value

Type	Description
OfflineInfo

OnEnterWorld

Declaration

public ThreadSafeAction<User> OnEnterWorld { get; }

Property Value

Type	Description
ThreadSafeAction<User>

OnInteract

Declaration

public ThreadSafeAction<User.InteractionEvent> OnInteract { get; }

Property Value

Type	Description
ThreadSafeAction<User.InteractionEvent>

OnInvisible

Declaration

public ThreadSafeAction<User> OnInvisible { get; }

Property Value

Type	Description
ThreadSafeAction<User>

OnItemInserted

Declaration

public ThreadSafeAction<string, Inventory> OnItemInserted { get; }

Property Value

Type	Description
ThreadSafeAction<System.String, Inventory>

OnlineTimeLog

Declaration

public TimeLog OnlineTimeLog { get; set; }

Property Value

Type	Description
TimeLog

OnLogin

Declaration

public ThreadSafeAction<User> OnLogin { get; }

Property Value

Type	Description
ThreadSafeAction<User>

OnLogOut

Declaration

public ThreadSafeAction<User> OnLogOut { get; }

Property Value

Type	Description
ThreadSafeAction<User>

OnMovedPlots

Declaration

public ThreadSafeAction OnMovedPlots { get; }

Property Value

Type	Description
ThreadSafeAction

OnTutorialEvent

Declaration

public ThreadSafeAction<TutorialWatch, Type> OnTutorialEvent { get; }

Property Value

Type	Description
ThreadSafeAction<TutorialWatch, System.Type>

OnWorkOrderCollect

Declaration

public ThreadSafeAction<WorkOrder> OnWorkOrderCollect { get; }

Property Value

Type	Description
ThreadSafeAction<WorkOrder>

OnWorkOrderComplete

Declaration

public ThreadSafeAction<WorkOrder> OnWorkOrderComplete { get; }

Property Value

Type	Description
ThreadSafeAction<WorkOrder>

OnWorkOrderCreated

Declaration

public ThreadSafeAction<WorkOrder> OnWorkOrderCreated { get; }

Property Value

Type	Description
ThreadSafeAction<WorkOrder>

OnWorkOrderDeposited

Declaration

public ThreadSafeAction<WorkOrder> OnWorkOrderDeposited { get; }

Property Value

Type	Description
ThreadSafeAction<WorkOrder>

OnWorkOrderLaborContributed

Declaration

public ThreadSafeAction<WorkOrder> OnWorkOrderLaborContributed { get; }

Property Value

Type	Description
ThreadSafeAction<WorkOrder>

OnWorldObjectPlaced

Declaration

public ThreadSafeAction<WorldObject> OnWorldObjectPlaced { get; }

Property Value

Type	Description
ThreadSafeAction<WorldObject>

OverheadName

Declaration

public string OverheadName { get; set; }

Property Value

Type	Description
System.String

OwnedPropertyValueChanged

Declaration

public ThreadSafeAction<Deed> OwnedPropertyValueChanged { get; }

Property Value

Type	Description
ThreadSafeAction<Deed>

Player

Declaration

public Player Player { get; }

Property Value

Type	Description
Player

PlayerObjective

Declaration

public string PlayerObjective { get; set; }

Property Value

Type	Description
System.String

Position

Declaration

public Vector3 Position { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

PostedContracts

Declaration

public IEnumerable<Contract> PostedContracts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Contract>

PredatorsProtected

Declaration

public bool PredatorsProtected { get; set; }

Property Value

Type	Description
System.Boolean

QueueHandle

Declaration

public IPriorityQueueHandle<ITickable> QueueHandle { get; set; }

Property Value

Type	Description
C5.IPriorityQueueHandle<ITickable>

RecentWatchedWorkOrders

Declaration

public IEnumerable<WorkOrder> RecentWatchedWorkOrders { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<WorkOrder>

ReportIpAddress

Declaration

public string ReportIpAddress { get; }

Property Value

Type	Description
System.String

ReportUserId

Declaration

public string ReportUserId { get; }

Property Value

Type	Description
System.String

ReportUsername

Declaration

public string ReportUsername { get; }

Property Value

Type	Description
System.String

Reputation

Declaration

public float Reputation { get; }

Property Value

Type	Description
System.Single

ResidencyPropertyValue

Declaration

public ResidencyPropertyValue ResidencyPropertyValue { get; }

Property Value

Type	Description
ResidencyPropertyValue

Rotation

Declaration

public Quaternion Rotation { get; set; }

Property Value

Type	Description
Quaternion

RunSpeed

Declaration

public float RunSpeed { get; }

Property Value

Type	Description
System.Single

Skillset

Declaration

public Skillset Skillset { get; set; }

Property Value

Type	Description
Skillset

SpawnPointSelected

Declaration

public bool SpawnPointSelected { get; set; }

Property Value

Type	Description
System.Boolean

SteamId

Declaration

public string SteamId { get; }

Property Value

Type	Description
System.String

Stomach

Declaration

public Stomach Stomach { get; }

Property Value

Type	Description
Stomach

StorageHandle

Declaration

public IPersistent StorageHandle { get; set; }

Property Value

Type	Description
IPersistent

StrangeId

Declaration

public string StrangeId { get; set; }

Property Value

Type	Description
System.String

StrangeItemManagement

Declaration

public StrangeItemManagement StrangeItemManagement { get; }

Property Value

Type	Description
StrangeItemManagement

StrangeUser

Declaration

public StrangeUser StrangeUser { get; }

Property Value

Type	Description
StrangeCloud.Service.Client.Contracts.StrangeUser

SwimSpeed

Declaration

public float SwimSpeed { get; }

Property Value

Type	Description
System.Single

SwimSpeedMultiplier

Declaration

public float SwimSpeedMultiplier { get; set; }

Property Value

Type	Description
System.Single

Talentset

Declaration

public Talentset Talentset { get; set; }

Property Value

Type	Description
Talentset

ToolbarSelected

Declaration

public ItemStack ToolbarSelected { get; }

Property Value

Type	Description
ItemStack

TotalPlayTime

Declaration

public double TotalPlayTime { get; set; }

Property Value

Type	Description
System.Double

TwitchId

Declaration

public string TwitchId { get; }

Property Value

Type	Description
System.String

UIStates

Declaration

public UserUIStates UIStates { get; set; }

Property Value

Type	Description
UserUIStates

UserAccounts

Declaration

public UserAccounts UserAccounts { get; }

Property Value

Type	Description
UserAccounts

UserAchievements

Declaration

public UserAchievements UserAchievements { get; }

Property Value

Type	Description
UserAchievements

UserCraftingLists

Declaration

public UserCraftingLists UserCraftingLists { get; }

Property Value

Type	Description
UserCraftingLists

UserDisplay

Declaration

public UserDisplay UserDisplay { get; }

Property Value

Type	Description
UserDisplay

UserImage

Declaration

public UserTexture UserImage { get; set; }

Property Value

Type	Description
UserTexture

UserSet

Declaration

public IEnumerable<User> UserSet { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<User>

UserSetChangedEvent

Declaration

public ThreadSafeAction<IEnumerable<User>> UserSetChangedEvent { get; set; }

Property Value

Type	Description
ThreadSafeAction<System.Collections.Generic.IEnumerable<User>>

UserSettings

Declaration

public UserSettings UserSettings { get; }

Property Value

Type	Description
UserSettings

UserTasks

Declaration

public UserTaskManager UserTasks { get; set; }

Property Value

Type	Description
UserTaskManager

UserTooltipDetails

Declaration

public UserTooltipDetails UserTooltipDetails { get; }

Property Value

Type	Description
UserTooltipDetails

UserXP

Declaration

public UserXP UserXP { get; }

Property Value

Type	Description
UserXP

Valid

Declaration

public bool Valid { get; }

Property Value

Type	Description
System.Boolean

VoiceData

Declaration

public VoiceData VoiceData { get; }

Property Value

Type	Description
VoiceData

Methods

AddRecipeToCraftingList(String, Int32)

Declaration

public void AddRecipeToCraftingList(string id, int recipeTypeId)

Parameters

Type	Name	Description
System.String	id
System.Int32	recipeTypeId

AddWatchedWorkOrder(WorkOrder, Boolean)

Declaration

public void AddWatchedWorkOrder(WorkOrder order, bool doUpdate = true)

Parameters

Type	Name	Description
WorkOrder	order
System.Boolean	doUpdate

ChangedCarryWeight()

Declaration

public void ChangedCarryWeight()

ChangedMovementSpeed()

Declaration

public void ChangedMovementSpeed()

CheckAccessForPlaying()

Declaration

public Result CheckAccessForPlaying()

Returns

Type	Description
Result

ClearInteractionCache()

Prompts client to clear interaction cache for this user, used when server side changes would change interactions for user e.g auth changes

Declaration

public void ClearInteractionCache()

CompareTo(Object)

Declaration

public int CompareTo(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Int32

ConsumeCalories(Single)

Declaration

public void ConsumeCalories(float change)

Parameters

Type	Name	Description
System.Single	change

ContainsExactAlias(IAlias)

Declaration

public bool ContainsExactAlias(IAlias alias)

Parameters

Type	Name	Description
IAlias	alias

Returns

Type	Description
System.Boolean

ContainsUser(User)

Declaration

public bool ContainsUser(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

ContractsChanged()

Declaration

public void ContractsChanged()

CreateCraftingList(String)

Declaration

public string CreateCraftingList(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.String

DebtChanged()

Declaration

public void DebtChanged()

DeleteCraftingList(String)

Declaration

public void DeleteCraftingList(string id)

Parameters

Type	Name	Description
System.String	id

Destroy()

Declaration

public void Destroy()

DiscordOpened()

Declaration

public void DiscordOpened()

EditView(IController)

Declaration

public void EditView(IController controller)

Parameters

Type	Name	Description
IController	controller

EnterWorld()

Declaration

public void EnterWorld()

Error(LocString)

Declaration

public void Error(LocString msg)

Parameters

Type	Name	Description
LocString	msg

ErrorLoc(FormattableString)

Declaration

public void ErrorLoc(FormattableString msg)

Parameters

Type	Name	Description
System.FormattableString	msg

ErrorLocStr(String)

Declaration

public void ErrorLocStr(string msg)

Parameters

Type	Name	Description
System.String	msg

ForceSpawnPointSelected()

Declaration

public void ForceSpawnPointSelected()

GetAllProperty()

Declaration

public List<Deed> GetAllProperty()

Returns

Type	Description
System.Collections.Generic.List<Deed>

GetAllRooms()

Declaration

public List<Vector3i> GetAllRooms()

Returns

Type	Description
System.Collections.Generic.List<Vector3i>

GetChatAuthLevel()

Declaration

public ChatAuthorizationLevel GetChatAuthLevel()

Returns

Type	Description
ChatAuthorizationLevel

GetState(String)

Declaration

public object GetState(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.Object

GetState<T>(String)

Declaration

public T GetState<T>(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
T

Type Parameters

Name	Description
T

HasState(String)

Declaration

public bool HasState(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.Boolean

InfoBox(LocString)

Declaration

public void InfoBox(LocString msg)

Parameters

Type	Name	Description
LocString	msg

InfoBoxLoc(FormattableString)

Displays an on screen info boxto the player, if the user has a player to show it to.

Declaration

public void InfoBoxLoc(FormattableString msg)

Parameters

Type	Name	Description
System.FormattableString	msg

InfoBoxLocStr(String)

Declaration

public void InfoBoxLocStr(string msg)

Parameters

Type	Name	Description
System.String	msg

InfoBoxOrMsg(LocString, NotificationCategory, NotificationStyle)

Declaration

public void InfoBoxOrMsg(LocString msg, NotificationCategory category, NotificationStyle style)

Parameters

Type	Name	Description
LocString	msg
NotificationCategory	category
NotificationStyle	style

InfoBoxOrMsgLoc(FormattableString, NotificationCategory, NotificationStyle)

Send an info box, unless theyre offline, then send a ,msg.

Declaration

public void InfoBoxOrMsgLoc(FormattableString msg, NotificationCategory category, NotificationStyle style)

Parameters

Type	Name	Description
System.FormattableString	msg
NotificationCategory	category
NotificationStyle	style

Initialize()

Declaration

public override void Initialize()

Overrides

SimpleEntry.Initialize()

IsLocal()

Declaration

public bool IsLocal()

Returns

Type	Description
System.Boolean

IsReady()

Declaration

public bool IsReady()

Returns

Type	Description
System.Boolean

Login(Player, INetClient, Boolean, Boolean)

Declaration

public Result Login(Player player, INetClient client, bool allowDisconnectionAfterActionFailure = true, bool ignoreTestMode = false)

Parameters

Type	Name	Description
Player	player
INetClient	client
System.Boolean	allowDisconnectionAfterActionFailure
System.Boolean	ignoreTestMode

Returns

Type	Description
Result

LoginCompleted()

To be called when client already have assigned WorldObserver.

Declaration

public void LoginCompleted()

Logout()

Declaration

public void Logout()

MarkDirty()

Declaration

public override void MarkDirty()

Overrides

SimpleEntry.MarkDirty()

Msg(LocString, NotificationStyle)

Declaration

public void Msg(LocString msg, NotificationStyle style)

Parameters

Type	Name	Description
LocString	msg
NotificationStyle	style

MsgLoc(FormattableString, NotificationStyle)

Declaration

public void MsgLoc(FormattableString msg, NotificationStyle style)

Parameters

Type	Name	Description
System.FormattableString	msg
NotificationStyle	style

MsgLocStr(String, NotificationStyle)

Declaration

public void MsgLocStr(string msg, NotificationStyle style)

Parameters

Type	Name	Description
System.String	msg
NotificationStyle	style

NotifyIncomeAndExpensesChange()

Force a change in Income and expenses object to update the state of it on client side.

Declaration

public void NotifyIncomeAndExpensesChange()

OkBox(LocString)

Declaration

public void OkBox(LocString msg)

Parameters

Type	Name	Description
LocString	msg

OkBoxLoc(FormattableString)

Displays an ok box to the player, if the user has a player to show it to.

Declaration

public void OkBoxLoc(FormattableString msg)

Parameters

Type	Name	Description
System.FormattableString	msg

OkBoxLocStr(String)

Declaration

public void OkBoxLocStr(string msg)

Parameters

Type	Name	Description
System.String	msg

OnDeserialized()

Declaration

protected void OnDeserialized()

OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

Declaration

public override void OnLinkClicked(TooltipOrigin origin, TooltipClickContext clickContext, User user)

Parameters

Type	Name	Description
TooltipOrigin	origin
TooltipClickContext	clickContext
User	user

Overrides

SimpleEntry.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

OnOwnedPropertyValueChanged(Deed)

Declaration

public void OnOwnedPropertyValueChanged(Deed deed)

Parameters

Type	Name	Description
Deed	deed

OnPropertyValueChanged()

Declaration

public void OnPropertyValueChanged()

OnRenamed(String)

Declaration

public void OnRenamed(string oldName)

Parameters

Type	Name	Description
System.String	oldName

OpenDiscordInvite(String)

Opens the overlay modal for joining a Discord guild, given its invite code. An invite code for a server may look something like eco for a verified server—the full invite being discord.gg/eco something like X3JeE4CV for a non-verified server, the full invite being https://discord.gg/X3JeE4CV.

Declaration

public void OpenDiscordInvite(string code)

Parameters

Type	Name	Description
System.String	code	The invite code for the guild you wish to invite the user to.

OpenServerWebpage(String)

Asks the user if they would like to open the web path on the server's internal web server.

Declaration

public void OpenServerWebpage(string webPath)

Parameters

Type	Name	Description
System.String	webPath	The web path you wish to open.

OpenWebpage(String)

Asks the user if they would like to open a external website url.

Declaration

public void OpenWebpage(string url)

Parameters

Type	Name	Description
System.String	url	The web url you wish to open.

OverrideAvatar(Avatar)

Declaration

public void OverrideAvatar(Avatar avatar)

Parameters

Type	Name	Description
Avatar	avatar

OverrideInventory(UserInventory)

Declaration

public void OverrideInventory(UserInventory inventory)

Parameters

Type	Name	Description
UserInventory	inventory

RefreshOverheadName()

Declaration

public void RefreshOverheadName()

RemoveRecipeFromCraftingList(String, Int32)

Declaration

public void RemoveRecipeFromCraftingList(string id, int recipeTypeId)

Parameters

Type	Name	Description
System.String	id
System.Int32	recipeTypeId

RemoveWatchedWorkOrder(WorkOrder)

Declaration

public void RemoveWatchedWorkOrder(WorkOrder order)

Parameters

Type	Name	Description
WorkOrder	order

RepUILink()

Declaration

public string RepUILink()

Returns

Type	Description
System.String

SetClientData(InitialData)

Sets client initial data for this user and calls any methods that use data for setup, Called right after data is returned from the client request

Declaration

public Task SetClientData(InitialData data)

Parameters

Type	Name	Description
InitialData	data

Returns

Type	Description
System.Threading.Tasks.Task

SetState(String, Object)

Declaration

public void SetState(string key, object val)

Parameters

Type	Name	Description
System.String	key
System.Object	val

SetUserTexture(Byte[])

Sets received byte array from the client as the user's avatar image.

Declaration

public Task SetUserTexture(byte[] tex)

Parameters

Type	Name	Description
System.Byte[]	tex

Returns

Type	Description
System.Threading.Tasks.Task

TabSelected(String)

On client-site event used when the user select a tab

Declaration

public void TabSelected(string title)

Parameters

Type	Name	Description
System.String	title

TempServerMessage(LocString, NotificationCategory, NotificationStyle)

Declaration

public void TempServerMessage(LocString message, NotificationCategory category, NotificationStyle style)

Parameters

Type	Name	Description
LocString	message
NotificationCategory	category
NotificationStyle	style

Tick()

Declaration

public void Tick()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

SimpleEntry.ToString()

TryDamage(INetObject, Single, DamageSourceType)

Tries to make damage to user. If fails for some reason (in example User out of calories) then returns false.

Declaration

public bool TryDamage(INetObject source, float damage, DamageSourceType sourceType)

Parameters

Type	Name	Description
INetObject	source
System.Single	damage
DamageSourceType	sourceType

Returns

Type	Description
System.Boolean

TryDamage(INetObject, Single, Boolean, DamageSourceType)

Declaration

public bool TryDamage(INetObject source, float damage, bool triggerEffectOnPlayer, DamageSourceType sourceType)

Parameters

Type	Name	Description
INetObject	source
System.Single	damage
System.Boolean	triggerEffectOnPlayer
DamageSourceType	sourceType

Returns

Type	Description
System.Boolean

TutorialEvent(TutorialWatch, Type)

Declaration

public void TutorialEvent(TutorialWatch flag, Type type = null)

Parameters

Type	Name	Description
TutorialWatch	flag
System.Type	type

UIClosed(String)

Declaration

public void UIClosed(string uiName)

Parameters

Type	Name	Description
System.String	uiName

UILinkContent()

Declaration

public override LocString UILinkContent()

Returns

Type	Description
LocString

Overrides

SimpleEntry.UILinkContent()

UIOpened(String)

Declaration

public void UIOpened(string uiName)

Parameters

Type	Name	Description
System.String	uiName

UpdateRoom()

Declaration

public void UpdateRoom()

Verify()

Declaration

public Result Verify()

Returns

Type	Description
Result

VoteWeight(Election)

Declaration

public float VoteWeight(Election election)

Parameters

Type	Name	Description
Election	election

Returns

Type	Description
System.Single

Explicit Interface Implementations

IHasReputation.UserSource

Declaration

User IHasReputation.UserSource { get; }

Returns

Type	Description
User

Implements

ILinkableParameterized<T>

ILinkable

IValidity

ICachesValidity

IDescribable

ISuffixName

IThreadSafeSubscriptions

ISubscriptions<TSubscriptionsList>

ISubscriptions

ITickable

System.IComparable

IStorage

ISerializable

IAlias

System.ComponentModel.INotifyPropertyChanged

ICanTakeDamage

IObserverConversionTarget

IChatReceiver

IHasID

INamed

IReInitializable

IHasReputation

IController

IViewController

IGivesReputation

IReputationAssociated

IHasReferenceableSerializableID

IHasSerializableID

IHasUniversalID

IHasBonuses

IChatClient

INotificationReceiver

Extension Methods

BonusContextExtensions.MakeBonusContext(User, BonusAction, Item)

TagUtils.TagNames(Object, Boolean)

TagUtils.TagDisplayNames(Object, Boolean)

PlayerExtensions.Mail(User, LocString, NotificationCategory)

PlayerExtensions.MailLoc(User, FormattableString, NotificationCategory)

PlayerExtensions.OkBoxLoc(User, FormattableString)

PlayerExtensions.ConfirmBoxLoc(User, FormattableString)

PlayerExtensions.ConfirmBox(User, LocString)

PlayerExtensions.OkBox(User, LocString)

PlayerExtensions.OkBox(User, LocString, Boolean)

PlayerExtensions.MsgOrMailLoc(User, FormattableString, NotificationCategory, NotificationStyle)

PlayerExtensions.MsgOrMail(User, LocString, NotificationCategory, NotificationStyle)

UserUtils.QAorAdminModeActive(User)

UserUtils.DescDemo(User)

ResidencyExtensions.IsResident(User, Deed)

ResidencyExtensions.GetResidencyDeed(User)

ResidencyExtensions.IsResidentType(User, SpecialResidents, IEnumerable<Deed>)

ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)

DemographicUtils.WasActivePreviousXDays(User, Single, Single)

ElectedTitleFuncs.CanChangeTreasuryTaxes(User, Settlement)

ElectedTitleFuncs.HasGovernmentBankingPrivileges(User, Settlement)

ElectedTitleFuncs.HasDiplomaticPrivileges(User, Settlement, Boolean)

ElectedTitleFuncs.CanChangeSettlementMarkers(User, Settlement, out ElectedTitle)

UserRPCButtonTestExtensions.TestLink(User, String)

UserRPCButtonTestExtensions.TestLinkNoArgs(User)

TypeTooltipExtensions.UILinkGeneric(Object)

ILinkableTooltipLibrary.UserLinkClicked(User)

MiscTooltipLibrary.SimpleEntryTooltip(SimpleEntry, User)

MiscTooltipLibrary.SimpleEntryTitle(SimpleEntry)

UserTooltipLibrary.ImageInTooltip(User)

UserTooltipLibrary.ChievesTooltip(User)

UserTooltipLibrary.RepTooltip(User)

UserTooltipLibrary.CitizenshipTooltip(User)

UserTooltipLibrary.KnownAsTooltip(User)

UserTooltipLibrary.TooltipStatus(User, User)

UserTooltipLibrary.DetailsTooltip(User)