API Reference
Messaging
| Type / function | Notes |
|---|
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 / BroadcastInstancedMessage | Blueprint broadcast (wildcard struct / FInstancedStruct) |
RegisterListener<T>(Channel, Callback, MatchType) | Returns FCrimsonMessageListenerHandle; member-function overloads are weak-object safe |
UnregisterListener(Handle) / Handle.Unregister() | Stop listening |
ECrimsonMessageMatch | ExactMatch or PartialMatch |
UCrimsonAsyncAction_ListenForMessage | Blueprint Listen For Crimson Messages node; OnMessageReceived, GetPayload |
Player classes
| Type | Notes |
|---|
UCrimsonCommonGameInstance | Abstract game instance base; local player added/removed events |
UCrimsonCommonLocalPlayer | CallAndRegister_OnPlayerControllerSet, CallAndRegister_OnPlayerStateSet, CallAndRegister_OnPlayerPawnSet |
ACrimsonCommonPlayerController | Modular controller that raises the local player delegates |
UCrimsonSessionSubsystem | Host, find, join sessions; UCrimsonSession_HostSessionRequest, UCrimsonSession_SearchResult |
UCrimsonUserSubsystem | Login, privileges, online context; UCrimsonUserInfo, FCrimsonUserInitializeParams |
Modular actors
| Type | Base |
|---|
ACrimsonModularCharacter | ACharacter |
ACrimsonModularPawn | APawn |
ACrimsonModularPlayerController | APlayerController |
ACrimsonModularPlayerState | APlayerState |
ACrimsonModularGameModeBase / ACrimsonModularGameMode | AGameModeBase / AGameMode |
ACrimsonModularGameStateBase / ACrimsonModularGameState | AGameStateBase / AGameState |
ACrimsonModularAIController | AAIController |
Editor utilities
| Type / command | Notes |
|---|
UCrimsonEditorUtilitiesSettings | Project Settings page: bEnableCommonMaps, CommonEditorMaps |
UCrimsonWidgetAuthoringLibrary | Editor-only Blueprint library: RemoveWidgetAnimation, PruneDeadAnimationBindings, GetWidgetAnimationNames |
Crimson.DevTools.Gallery | Opens the DevTools Gallery |
ICrimsonWikiAction, FCrimsonWikiActionRegistry | Register actions for wiki button blocks |