Difference between revisions of "Itemproperty keyword"

Revision as of 05:29, 1 August 2009

The itemproperty type represents a dynamic property which can be added to or removed from an item.

Literals

A literal is a textual representation of a particular value of a type.

There is no literal for an itemproperty.

Conversion

There is no explicit or implicit conversion to or from an itemproperty.

Persistence

The following functions allow an itemproperty to exist outside of the scope of the current script by storing it on an object, effect or event:

• SetLocalItemProperty

The following functions allow an itemproperty which exist outside of the scope of the current script to be used in the current script by retrieving it from an object, effect or event:

• GetLocalItemProperty

Remarks

Item properties are added to an item using AddItemProperty and removed using RemoveItemProperty. An array of the item properties on an item can be retrieved using GetItemProperties.

Examples

void main()
{
    // uninitialised
    itemproperty ipDefault;
 
    // initialised using a function
    itemproperty ipExample = GetLocalItemProperty(OBJECT_SELF, "example");    
}

See Also

Itemproperty functions