ResourceShortType Class

Localized message formatting class for a string value that represents an abbreviated resource type.

Inheritance Hierarchy

SystemObject
KSPDev.GUIUtils.TypeFormattersResourceShortType

Namespace: KSPDev.GUIUtils.TypeFormatters
Assembly: KSPDev_Utils.2.0 (in KSPDev_Utils.2.0.dll) Version: 2.0 for KSP v1.8+

Syntax

Copy

public sealed class ResourceShortType

Request Example View Source

The ResourceShortType type exposes the following members.

Constructors

	Name	Description
	ResourceShortType(Int32)	Constructs an object from a resource ID.
	ResourceShortType(String)	Constructs an object from a resource nane.

Top

Methods

	Name	Description
	Format(Int32)	Formats the value into a human friendly localized string.
	Format(String)	Formats the value into a human friendly localized string.
	ToString	Returns a string formatted as a human friendly resource name. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	(Int32 to ResourceShortType)	Coverts a resource ID value into a type object.
	(String to ResourceShortType)	Coverts a resource name value into a type object.
	(ResourceShortType to String)	Converts a type object into a resource name.
	(ResourceShortType to Int32)	Converts a type object into a resource ID.

Top

Fields

	Name	Description
	resourceId	A wrapped resource ID value.

Top

Remarks

This class resolves the resource type/ID into it's short localized name. It's usually 2 letters long, but it's not mandatory.

Use it as a generic parameter when creating a LocalizableMessage descendants.

Examples

Copy

public class ResourceShortTypeDemo1 : PartModule {
  static readonly Message<ResourceShortType> msg1 = new Message<ResourceShortType>(
      "#TypeDemo_msg1", defaultTemplate: "Resource is: <<1>>");

  void Show() {
    Debug.Log(msg1.Format(StockResourceNames.ElectricCharge));
    // Prints: "Resource is: EC"
    Debug.Log(msg1.Format(PartResourceLibrary.ElectricityHashcode));
    // Prints: "Resource is: EC"
  }
}

Examples

Copy

Debug.Log(ResourceShortType.Format(StockResourceNames.ElectricCharge));
// Prints: "Resource is: EC"
Debug.Log(ResourceShortType.Format(PartResourceLibrary.ElectricityHashcode));
// Prints: "Resource is: EC"