Class ParamExplanation

Lists params relevant to the player, optionally showing currently assigned values of passed in instances, along with descriptions of each.

Inheritance

System.Object

ParamExplanation

Namespace: Eco.Gameplay.Systems.NewTooltip

Assembly: Eco.Gameplay.dll

Syntax

public static class ParamExplanation : Object

Methods

DescribeType(Type, Boolean, Func<MemberInfo, Boolean>, Object[])

Declaration

public static LocString DescribeType(Type type, bool showHeaders, Func<MemberInfo, bool> filter, params object[] instances)

Parameters

Type	Name	Description
System.Type	type
System.Boolean	showHeaders
System.Func<System.Reflection.MemberInfo, System.Boolean>	filter
System.Object[]	instances

Returns

Type	Description
LocString

DescribeType(Type, Object[])

Declaration

public static LocString DescribeType(Type type, params object[] instances)

Parameters

Type	Name	Description
System.Type	type
System.Object[]	instances

Returns

Type	Description
LocString

DescribeTypeAttributes(Type, LocStringBuilder)

Declaration

public static void DescribeTypeAttributes(this Type type, LocStringBuilder sb)

Parameters

Type	Name	Description
System.Type	type
LocStringBuilder	sb

GetDescriptionRowForProperty(Type, PropertyInfo, Object[])

Forms the list containing the display text of a row that describes a type's property.

Currently holds 'Icon + Name' on first index, and 'Description' (if any) on second index.

Declaration

public static List<LocString> GetDescriptionRowForProperty(Type baseType, PropertyInfo prop, object[] instances = null)

Parameters

Type	Name	Description
System.Type	baseType
System.Reflection.PropertyInfo	prop
System.Object[]	instances

Returns

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

SimpleDescribeProperties(Object)

Declaration

public static string SimpleDescribeProperties(object instance)

Parameters

Type	Name	Description
System.Object	instance

Returns

Type	Description
System.String

Table(Type, Boolean, Func<MemberInfo, Boolean>, Object[])

Declaration

public static IEnumerable<IEnumerable<LocString>> Table(Type type, bool showHeaders, Func<MemberInfo, bool> filter, object[] instances)

Parameters

Type	Name	Description
System.Type	type
System.Boolean	showHeaders
System.Func<System.Reflection.MemberInfo, System.Boolean>	filter
System.Object[]	instances

Returns

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

Table2d(Type, Object[])

Declaration

public static LocString[, ] Table2d(Type type, object[] instances)

Parameters

Type	Name	Description
System.Type	type
System.Object[]	instances

Returns

Type	Description
LocString[,]

Table2dStrippedTags(Type, Object[])

Declaration

public static LocString[, ] Table2dStrippedTags(Type type, object[] instances)

Parameters

Type	Name	Description
System.Type	type
System.Object[]	instances

Returns

Type	Description
LocString[,]

Table2dStrippedTagsAsString(Type, Object[])

Declaration

public static string[, ] Table2dStrippedTagsAsString(Type type, object[] instances)

Parameters

Type	Name	Description
System.Type	type
System.Object[]	instances

Returns

Type	Description
System.String[,]