Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → URazerChromaFunctionLibrary
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 |
|
static float GetTotalDuration
(
const URazerChromaAnimationAsset* Anim |
Returns the duration in seconds of the specified animation. | RazerChromaFunctionLibrary.h |
|
static bool IsAnimationPlaying
(
const URazerChromaAnimationAsset* Anim |
Returns true if the given animation is currently playing. | RazerChromaFunctionLibrary.h |
|
static bool IsChromaAnimationPaused
(
const URazerChromaAnimationAsset* Anim |
Returns true if the given animation is currently paused. | RazerChromaFunctionLibrary.h |
|
static bool IsChromaRuntimeAvailable () |
Returns true if the Razer Chroma runtime libraries are currently available. | RazerChromaFunctionLibrary.h |
|
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 |
|
static bool PlayChromaAnimation
(
const URazerChromaAnimationAsset* AnimToPlay, |
Attempts to play the given Chroma animation file. | RazerChromaFunctionLibrary.h |
|
static void ResumeChromaAnimation
(
const URazerChromaAnimationAsset* AnimToResume, |
Resumes the given animation if it has been paused. | RazerChromaFunctionLibrary.h |
|
static void SetAllDevicesStaticColor
(
const FColor& ColorToSet, |
Sets the color of every connected Razer Chroma Device to this static color | RazerChromaFunctionLibrary.h | |
static void SetAllDevicesStaticColor
(
const FColor& ColorToSet, |
Sets the color of every connected Razer Chroma Device to this static color | RazerChromaFunctionLibrary.h |
|
static int32 SetEventName
(
const FString& name |
Name the Chroma event to add extras like haptics to supplement the event | RazerChromaFunctionLibrary.h |
|
static void SetIdleAnimation
(
const URazerChromaAnimationAsset* NewIdleAnimation |
Sets the idle animation for this application. | RazerChromaFunctionLibrary.h |
|
static void SetUseIdleAnimation
(
const bool bUseIdleAnimation |
Sets whether or not we should use an idle currently an animation | RazerChromaFunctionLibrary.h |
|
static void StopAllChromaAnimations() |
Stops all currently active Chroma animations | RazerChromaFunctionLibrary.h |
|
static void StopChromaAnimation
(
const URazerChromaAnimationAsset* AnimToStop |
Stops the given Chroma Animation if it is currently playing. | RazerChromaFunctionLibrary.h |
|
static void UseForwardChromaEvents
(
const bool bToggle |
On by default, UseForwardChromaEvents_ sends the animation name to SetEventName_ automatically when `PlayAnimationName_ is called. |
RazerChromaFunctionLibrary.h |
|