FRigVMFunction_MathFloatWrap

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.

API > API/Plugins > API/Plugins/RigVM

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.

   
Name FRigVMFunction_MathFloatWrap
Type struct
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMFunctions/Math/RigVMFunction_MathFloat.h
Include Path #include "RigVMFunctions/Math/RigVMFunction_MathFloat.h"

Syntax

USTRUCT (Meta=(DisplayName="Wrap", TemplateName="Wrap", Keywords="Range,Remap"))  
struct FRigVMFunction_MathFloatWrap : public FRigVMFunction_MathFloatBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigVMFunction_MathFloatWrap()

   RigVMFunctions/Math/RigVMFunction_MathFloat.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Maximum float The Maximum for the resulting range. RigVMFunctions/Math/RigVMFunction_MathFloat.h
  • Meta=(Input)
Minimum float The Minimum for the resulting range. RigVMFunctions/Math/RigVMFunction_MathFloat.h
  • Meta=(Input)
Result float The resulting wrapped value. RigVMFunctions/Math/RigVMFunction_MathFloat.h
  • Meta=(Output)
Value float The number to wrap. RigVMFunctions/Math/RigVMFunction_MathFloat.h
  • Meta=(Input)

Functions

Public

Public Virtual

Overridden from FRigVMStruct

Name Remarks Include Path Unreal Specifiers

virtual void Execute()

 Execute logic for this struct RigVMFunctions/Math/RigVMFunction_MathFloat.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page