Interface ICustomProperties

Custom properties that you can attach to entities and can be used to get/set values during the game.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface ICustomProperties

Properties

Bools

Gets a collection of properties which type is a boolean (true/false).

Declaration

ICustomPropertiesPerType<bool> Bools { get; }

Property Value

Type	Description
ICustomPropertiesPerType<System.Boolean>	The bools.

Entities

Gets a collection of properties which type is an entity (can be any game object).

Declaration

ICustomPropertiesPerType<IEntity> Entities { get; }

Property Value

Type	Description
ICustomPropertiesPerType<IEntity>	The entities.

Floats

Gets a collection of properties which type is a float (numbers with decimal point).

Declaration

ICustomPropertiesPerType<float> Floats { get; }

Property Value

Type	Description
ICustomPropertiesPerType<System.Single>	The floats.

Ints

Gets a collection of properties which type is an integer (whole numbers).

Declaration

ICustomPropertiesPerType<int> Ints { get; }

Property Value

Type	Description
ICustomPropertiesPerType<System.Int32>	The ints.

Strings

Gets a collection of properties which type is a string (text).

Declaration

ICustomPropertiesPerType<string> Strings { get; }

Property Value

Type	Description
ICustomPropertiesPerType<System.String>	The strings.

Methods

CopyFrom(ICustomProperties)

Copies the custom properties from the specified object into this object. This will override existing values, but will not delete custom properties with no equivalent in the given object.

Declaration

void CopyFrom(ICustomProperties properties)

Parameters

Type	Name	Description
ICustomProperties	properties	Properties.

RegisterCustomData(ICustomSerializable)

Declaration

void RegisterCustomData(ICustomSerializable customData)

Parameters

Type	Name	Description
ICustomSerializable	customData