unreal.RigVMFunction_MathFloatWrap

class unreal.RigVMFunction_MathFloatWrap(value: float = 0.0, minimum: float = 0.0, maximum: float = 0.0, result: float = 0.0)

Bases: RigVMFunction_MathFloatBase

Wraps the given value to be within minimum and maximum, inclusive When the value can wrap to both Min and Max, it will wrap to Min if it lies below the range and wrap to Max if it is above the range.

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMFunction_MathFloat.h

Editor Properties: (see get_editor_property/set_editor_property)

  • maximum (float): [Read-Write] The Maximum for the resulting range

  • minimum (float): [Read-Write] The Minimum for the resulting range

  • result (float): [Read-Write] The resulting wrapped value

  • value (float): [Read-Write] The number to wrap

property maximum: float

[Read-Write] The Maximum for the resulting range

Type:

(float)

property minimum: float

[Read-Write] The Minimum for the resulting range

Type:

(float)

property result: float

[Read-Only] The resulting wrapped value

Type:

(float)

property value: float

[Read-Write] The number to wrap

Type:

(float)