1. Epic GamesDeveloper
  3. URazerChromaFunctionLibrary

URazerChromaFunctionLibrary

Function library for Razer Chroma devices.

API > API/Plugins > API/Plugins/RazerChromaDevices

Function library for Razer Chroma devices.

This function library is the main way that your gameplay code will likley interact with the Razer Chroma API to play animations or set any custom effects

   
Name URazerChromaFunctionLibrary
Type class
Header File /Engine/Plugins/Experimental/RazerChromaDevices/Source/RazerChromaDevices/Public/RazerChromaFunctionLibrary.h
Include Path #include "RazerChromaFunctionLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class URazerChromaFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FString Conv_RazerChromaDeviceTypesToString ( UPARAM(meta=(Bitmask, BitmaskEnum="/Script/RazerChromaDevices.ERazerChromaDeviceTypes")) const int32...
)

 Converts a ERazerChromaDeviceTypes enum to string. RazerChromaFunctionLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(DisplayName="To String (ERazerChromaDeviceTypes)", CompactNodeTitle="->", BlueprintAutocast)

static float GetTotalDuration ( const URazerChromaAnimationAsset* Anim
)

 Returns the duration in seconds of the specified animation. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • BlueprintCosmetic
  • Category="Razer Chroma"

static bool IsAnimationPlaying ( const URazerChromaAnimationAsset* Anim
)

 Returns true if the given animation is currently playing. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Razer Chroma"
  • Meta=(ReturnDisplayName="Is Playing")

static bool IsChromaAnimationPaused ( const URazerChromaAnimationAsset* Anim
)

 Returns true if the given animation is currently paused. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Razer Chroma"

static bool IsChromaRuntimeAvailable ()

 Returns true if the Razer Chroma runtime libraries are currently available. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Razer Chroma"

static FString LexToString ( const ERazerChromaDeviceTypes DeviceTypes
)

 Converts ERazerChromaDeviceTypes enum to FString. RazerChromaFunctionLibrary.h  

static void PauseChromaAnimation ( const URazerChromaAnimationAsset* AnimToPause
)

 Pauses the given animation if it is currently playing RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

static bool PlayChromaAnimation ( const URazerChromaAnimationAsset* AnimToPlay,
const bool bLooping
)

 Attempts to play the given Chroma animation file. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"
  • Meta=(ReturnDisplayName="Was Successful")

static void ResumeChromaAnimation ( const URazerChromaAnimationAsset* AnimToResume,
const bool bLoop
)

 Resumes the given animation if it has been paused. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

static void SetAllDevicesStaticColor ( const FColor& ColorToSet,
const ERazerChromaDeviceTypes DeviceTypes
)

 Sets the color of every connected Razer Chroma Device to this static color RazerChromaFunctionLibrary.h  

static void SetAllDevicesStaticColor ( const FColor& ColorToSet,
UPARAM(meta=(Bitmask, BitmaskEnum="/Script/RazerChromaDevices.ERazerChromaDeviceTypes")) const int32...
)

 Sets the color of every connected Razer Chroma Device to this static color RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"
  • Meta=(AutoCreateRefTerm="ColorToSet")

static int32 SetEventName ( const FString& name
)

 Name the Chroma event to add extras like haptics to supplement the event RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

static void SetIdleAnimation ( const URazerChromaAnimationAsset* NewIdleAnimation
)

 Sets the idle animation for this application. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

static void SetUseIdleAnimation ( const bool bUseIdleAnimation
)

 Sets whether or not we should use an idle currently an animation RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

static void StopAllChromaAnimations()

 Stops all currently active Chroma animations RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

static void StopChromaAnimation ( const URazerChromaAnimationAsset* AnimToStop
)

 Stops the given Chroma Animation if it is currently playing. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

static void UseForwardChromaEvents ( const bool bToggle
)

 On by default, UseForwardChromaEvents_ sends the animation name to SetEventName_ automatically when `PlayAnimationName_ is called. RazerChromaFunctionLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Razer Chroma"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page