API Reference

Messaging

Type / functionNotes
UCrimsonMessageSubsystem::Get(WorldContext)Game instance subsystem accessor
BroadcastMessage<T>(Channel, Message)C++ typed broadcast
BroadcastMessageRaw(Channel, StructType, Bytes)C++ broadcast of a struct known only by its UScriptStruct
Broadcast Message / BroadcastInstancedMessageBlueprint broadcast (wildcard struct / FInstancedStruct)
RegisterListener<T>(Channel, Callback, MatchType)Returns FCrimsonMessageListenerHandle; member-function overloads are weak-object safe
UnregisterListener(Handle) / Handle.Unregister()Stop listening
ECrimsonMessageMatchExactMatch or PartialMatch
UCrimsonAsyncAction_ListenForMessageBlueprint Listen For Crimson Messages node; OnMessageReceived, GetPayload

Player classes

TypeNotes
UCrimsonCommonGameInstanceAbstract game instance base; local player added/removed events
UCrimsonCommonLocalPlayerCallAndRegister_OnPlayerControllerSet, CallAndRegister_OnPlayerStateSet, CallAndRegister_OnPlayerPawnSet
ACrimsonCommonPlayerControllerModular controller that raises the local player delegates
UCrimsonSessionSubsystemHost, find, join sessions; UCrimsonSession_HostSessionRequest, UCrimsonSession_SearchResult
UCrimsonUserSubsystemLogin, privileges, online context; UCrimsonUserInfo, FCrimsonUserInitializeParams

Modular actors

TypeBase
ACrimsonModularCharacterACharacter
ACrimsonModularPawnAPawn
ACrimsonModularPlayerControllerAPlayerController
ACrimsonModularPlayerStateAPlayerState
ACrimsonModularGameModeBase / ACrimsonModularGameModeAGameModeBase / AGameMode
ACrimsonModularGameStateBase / ACrimsonModularGameStateAGameStateBase / AGameState
ACrimsonModularAIControllerAAIController

Editor utilities

Type / commandNotes
UCrimsonEditorUtilitiesSettingsProject Settings page: bEnableCommonMaps, CommonEditorMaps
UCrimsonWidgetAuthoringLibraryEditor-only Blueprint library: RemoveWidgetAnimation, PruneDeadAnimationBindings, GetWidgetAnimationNames
Crimson.DevTools.GalleryOpens the DevTools Gallery
ICrimsonWikiAction, FCrimsonWikiActionRegistryRegister actions for wiki button blocks