Class DefaultGameObjectFormatter
The default style of formatting game objects in a user-friendly way.
Implements
Inherited Members
Namespace: Microsoft.XboxStudios.GameStateTracker
Assembly: GameStateTracker.Core.dll
Syntax
public class DefaultGameObjectFormatter : IGameObjectFormatterMethods
View SourceFormat(object, out ObjectInfo?)
Converts the value to a user-friendly string.
Declaration
public static string Format(object value, out ObjectInfo? linkedObject)Parameters
| Type | Name | Description |
|---|---|---|
| object | value | The value to convert. |
| ObjectInfo? | linkedObject | A reference to a game object represented by the value (not used). |
Returns
| Type | Description |
|---|---|
| string | The string. |
FormatName(ObjectInfo)
Formats the object's name.
Declaration
public 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
public 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. |