Notch Notch Manual 0.9.23
 Light | Dark
SetEnvelopeValue()

SetEnvelopeValue()

Purpose #

Sets the value of a float property in a node but only for run/calculation time.

Syntax #

void SetEnvelopeValue(String field_name, float value);

Parameters

field_nameThe field name (NB: Does not require the group name)
valueThe float value the property is to be set to

Example #

function Update()
{ 
    layer = Document.FindLayer("My Layer");
    node = layer.FindNode("Frame Buffer");
    node.SetEnvelopeValue("Position X", 1.3);
}
Using SetEnvelopeValue only has an effect at run-time / calculation-time. i.e. it does not change the value in the Editor/Document. SetEnvelopeValue also responds to keyframes and modifiers. This is subtly different to SetFloat which alters the underlying editor value and hence persists.