SetUserProperty

Sets the value of a user property specified within the first parameter.

🔁 Function

void SetUserProperty(
    userPropertyName: string, 
    value: object);

⚙️ Parameters

Name Type Description
userPropertyName String The name of the property to set
value Object The value to set the property to

↩️ Return Value

None

📝 Example

Assumes a user property of ‘ramp’ has been created for Conveyors

let cc = GetComponentByNameAndType("Conveyor1", "Conveyor");
cc.SetUserProperty("ramp", 0.3);
LogDebug("Ramp=" + cc.GetUserProperty("ramp"));