Class TooltipServerResponse

Packs data server sends to client in response to TooltipServerRequest

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

Constructors

TooltipServerResponse()

Declaration
public TooltipServerResponse()

TooltipServerResponse(LocString, LocString)

Declaration
public TooltipServerResponse(LocString errorTitle, LocString errorMessage)
Parameters
Type Name Description
LocString errorTitle
LocString errorMessage

TooltipServerResponse(List<TooltipPartData>, List<TooltipChildrenPartData>)

Declaration
public TooltipServerResponse(List<TooltipPartData> parts, List<TooltipChildrenPartData> childrenParts)
Parameters
Type Name Description
System.Collections.Generic.List<TooltipPartData> parts
System.Collections.Generic.List<TooltipChildrenPartData> childrenParts

Fields

ChildrenParts

Declaration
public List<TooltipChildrenPartData> ChildrenParts
Field Value
Type Description
System.Collections.Generic.List<TooltipChildrenPartData>

ErrorMessage

If tooltip content can't be generated this error message should be displayed as tooltip content instead.

Declaration
public LocString ErrorMessage
Field Value
Type Description
LocString

ErrorTitle

If tooltip content can't be generated this error should be displayed as title instead.

Declaration
public LocString ErrorTitle
Field Value
Type Description
LocString

Parts

IDs and contents of requested tooltip parts.

Declaration
public List<TooltipPartData> Parts
Field Value
Type Description
System.Collections.Generic.List<TooltipPartData>

Properties

IsSuccess

Returns false if tooltip content couldn't be generated.

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

Methods

FromBson(BSONArray)

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

ToBson()

Declaration
public BSONArray ToBson()
Returns
Type Description
BSONArray

Implements

Extension Methods