Interface IGameObjectFormatter
An interface for formatting game objects in a user-friendly way.
Namespace: Microsoft.XboxStudios.GameStateTracker
Assembly: GameStateTracker.Abstractions.dll
Syntax
public interface IGameObjectFormatter
Methods
View SourceFormatName(ObjectInfo)
Formats the object's name.
Declaration
string FormatName(ObjectInfo info)
Parameters
| Type | Name | Description |
|---|---|---|
| ObjectInfo | info | The object info. |
Returns
| Type | Description |
|---|---|
| string | A string representation of the name. |
FormatPropertyValue(object, out ObjectInfo?)
Formats the given property value.
Declaration
string FormatPropertyValue(object value, out ObjectInfo? linkedObject)
Parameters
| Type | Name | Description |
|---|---|---|
| object | value | The value. |
| ObjectInfo? | linkedObject | A reference to a game object represented by the value. |
Returns
| Type | Description |
|---|---|
| string | A string representation of the value. |