GetUserProperty
Returns the value of a user property, this property may be predefined or only referenced within the script
Function
Object GetUserProperty(userPropertyName: string);
Parameters
Name | Type | Description |
---|---|---|
userPropertyName | String | The name of the property to retrieve |
Return Value
An object that represents the current value of the user property requested
Example
Assumes a user property of ‘ramp’ has been created for Conveyors
oConv1 = GetComponentByNameAndType("Conveyor1","Conveyor");
oConv1.SetUserProperty("ramp",0.3);
LogDebug("Ramp=" + oConv2.GetUserProperty("ramp"));