Class ViewClassInfo

Represents the 'type' data about a server type, something which is also represented as a view. The server builds these viewclassinfos and sends them to the client, which can then use them for many purposes. Any information about a type can be transmitted from server to client on this class.

Inheritance
System.Object
ViewClassInfo
Namespace: Eco.Shared.View
Assembly: Eco.Shared.dll
Syntax
[BsonAutoSerialize]
public class ViewClassInfo : Object, IBsonSerialize, IBsonSerializable, IBsonDeserializable

Constructors

ViewClassInfo()

Declaration
public ViewClassInfo()

Fields

BaseTypeID

Declaration
public int BaseTypeID
Field Value
Type Description
System.Int32

BaseTypeName

Declaration
public string BaseTypeName
Field Value
Type Description
System.String

CategoryName

Declaration
public string CategoryName
Field Value
Type Description
System.String

ClassFlags

Declaration
public ViewClassFlags ClassFlags
Field Value
Type Description
ViewClassFlags

ComponentTabName

Declaration
public string ComponentTabName
Field Value
Type Description
System.String

Description

Declaration
public LocString Description
Field Value
Type Description
LocString

DisplayName

Declaration
public LocString DisplayName
Field Value
Type Description
LocString

DisplayNamePlural

Declaration
public LocString DisplayNamePlural
Field Value
Type Description
LocString

EcopediaCategory

Declaration
public string EcopediaCategory
Field Value
Type Description
System.String

EcopediaPage

Declaration
public string EcopediaPage
Field Value
Type Description
System.String

EcopediaSubPageOrPage

Declaration
public string EcopediaSubPageOrPage
Field Value
Type Description
System.String

EnumDescriptions

Declaration
public LocString[] EnumDescriptions
Field Value
Type Description
LocString[]

EnumNames

Declaration
public string[] EnumNames
Field Value
Type Description
System.String[]

IconName

Declaration
public string IconName
Field Value
Type Description
System.String

Interfaces

Declaration
public string[] Interfaces
Field Value
Type Description
System.String[]

MarkedUpName

Declaration
public LocString MarkedUpName
Field Value
Type Description
LocString

Members

Data about each member of this type, transmitted from server to client.

Declaration
public Dictionary<string, ViewMemberInfo> Members
Field Value
Type Description
System.Collections.Generic.Dictionary<System.String, ViewMemberInfo>

Name

Name of the client side type (IE: "UserView")

Declaration
public string Name
Field Value
Type Description
System.String

Priority

Declaration
public int Priority
Field Value
Type Description
System.Int32

RelatedFeatureDisabledName

Declaration
public string RelatedFeatureDisabledName
Field Value
Type Description
System.String

RelatedFeatureName

Declaration
public string RelatedFeatureName
Field Value
Type Description
System.String

RPCs

Declaration
public List<ViewRPC> RPCs
Field Value
Type Description
System.Collections.Generic.List<ViewRPC>

ServerName

Name of the server side type (IE: "User")

Declaration
public string ServerName
Field Value
Type Description
System.String

Tags

Declaration
public HashSet<string> Tags
Field Value
Type Description
System.Collections.Generic.HashSet<System.String>

Type

Declaration
[BsonSerializeIgnore]
public Type Type
Field Value
Type Description
System.Type

TypeID

Declaration
public int TypeID
Field Value
Type Description
System.Int32

UITypeName

Declaration
public string UITypeName
Field Value
Type Description
System.String

Properties

IsEnum

Declaration
public bool IsEnum { get; }
Property Value
Type Description
System.Boolean

Methods

DerivesType(String, Boolean)

Declaration
public bool DerivesType(string parent, bool checkReverseToo = false)
Parameters
Type Name Description
System.String parent
System.Boolean checkReverseToo
Returns
Type Description
System.Boolean

FromBson(BSONArray)

Declaration
public void FromBson(BSONArray bson)
Parameters
Type Name Description
BSONArray bson

GetMemberInfo(String)

Declaration
public ViewMemberInfo GetMemberInfo(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
ViewMemberInfo

HasMember(String)

Declaration
public bool HasMember(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Boolean

HasTag(String)

Declaration
public bool HasTag(string tag)
Parameters
Type Name Description
System.String tag
Returns
Type Description
System.Boolean

SelfAndParentTypes()

Returns the viewclassinfo of ourself and each parent

Declaration
public IEnumerable<ViewClassInfo> SelfAndParentTypes()
Returns
Type Description
System.Collections.Generic.IEnumerable<ViewClassInfo>

ToBson()

Declaration
public BSONArray ToBson()
Returns
Type Description
BSONArray

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

Extension Methods