Class CustomPieceTable
Main interface for adding custom piece tables to the game.
All custom piece tables have to be wrapped inside this class to add it to Jötunns PieceManager.
Add strings to Categories to use custom categories on your piece table. All categories will be replaced so list vanilla categories, too.
All custom piece tables have to be wrapped inside this class to add it to Jötunns PieceManager.
Add strings to Categories to use custom categories on your piece table. All categories will be replaced so list vanilla categories, too.
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Jotunn.Entities
Assembly: Jotunn.dll
Syntax
public class CustomPieceTable : CustomEntity
Constructors
| Improve this Doc View SourceCustomPieceTable(GameObject)
Custom piece table from a prefab.
Declaration
public CustomPieceTable(GameObject pieceTablePrefab)
Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | pieceTablePrefab | The prefab for this custom piece table. |
CustomPieceTable(GameObject, PieceTableConfig)
Custom piece table from a prefab with a PieceTableConfig attached.
Declaration
public CustomPieceTable(GameObject pieceTablePrefab, PieceTableConfig config)
Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | pieceTablePrefab | The prefab for this custom piece table. |
| PieceTableConfig | config | The PieceTableConfig for this custom piece table. |
CustomPieceTable(String, PieceTableConfig)
"Empty" custom piece table with a PieceTableConfig attached.
Declaration
public CustomPieceTable(string name, PieceTableConfig config)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the custom piece table. |
| PieceTableConfig | config | The PieceTableConfig for this custom piece table. |
Properties
| Improve this Doc View SourceCategories
String array of categories used on the .
Will be ignored when m_useCategories is false.
All categories provided here will be used and displayed on the .
All categories provided here will be used and displayed on the
Declaration
public string[] Categories { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String[] |
PieceTable
The component for this custom piece table as a shortcut.
Declaration
public PieceTable PieceTable { get; }
Property Value
| Type | Description |
|---|---|
| PieceTable |
PieceTablePrefab
The prefab for this custom piece table.
Declaration
public GameObject PieceTablePrefab { get; }
Property Value
| Type | Description |
|---|---|
| GameObject |
Methods
| Improve this Doc View SourceEquals(Object)
Declaration
public override bool Equals(object obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
System.Object.Equals(System.Object)
|
Improve this Doc
View Source
GetHashCode()
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
System.Object.GetHashCode()
|
Improve this Doc
View Source
IsValid()
Checks if a custom piece table is valid (i.e. has a prefab and a PieceTable component).
Declaration
public bool IsValid()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if all criteria is met |
ToString()
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| System.String |
Overrides
System.Object.ToString()