ResourceType Class

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

Inheritance Hierarchy

SystemObject
KSPDev.GUIUtils.TypeFormattersResourceType

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 ResourceType

Request Example View Source

The ResourceType type exposes the following members.

Constructors

	Name	Description
	ResourceType(Int32)	Constructs an object from a resource ID.
	ResourceType(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 ResourceType)	Coverts a resource ID value into a type object.
	(String to ResourceType)	Coverts a resource name value into a type object.
	(ResourceType to String)	Converts a type object into a resource name.
	(ResourceType 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 full localized name.

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

Examples

Copy

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

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

Examples

Copy

Debug.Log(ResourceType.Format(StockResourceNames.ElectricCharge));
// Prints: "Resource is: Electric Charge"
Debug.Log(ResourceType.Format(PartResourceLibrary.ElectricityHashcode));
// Prints: "Resource is: Electric Charge"