https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/index.html Overview The CCHARUMODULE is a character framework providing pre-assembled base classes for actors, pawns, characters, projectiles and players. Each base class comes with a component-based architecture where components are automatically created and wired in the constructor via UCInitializerComponent. At runtime, a data-driven spawner system instantiates and manages actors in a tile-based pooling pipeline, while a separate player spawner handles player creation and possession. Hugo en-us Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/blueprint/index.html Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/blueprint/index.html Overview UCCharBPLibrary exposes character query functions to Blueprint. All functions are BlueprintCallable and BlueprintPure under the Cdryx|Char|CCharBPLibrary category. Functions Name Description retrieveCurrentPlayer Returns the current player pawn from the ACPlayerSpawner singleton retrieveTeamAttitude_ Returns the team attitude between two pawns (Friendly, Neutral, Hostile) retrieveMainTag Returns the mainTag FName from the actor’s UCInitializerComponent Begin Object Class="/Script/BlueprintGraph.K2Node_CallFunction" Name="K2Node_CallFunction_0" bIsPureFunc=True FunctionReference=(MemberParent=/Script/CoreUObject.Class'"/Script/CdryxCharUModule.CCharBPLibrary"',MemberName="retrieveCurrentPlayer") NodePosX=0 NodePosY=0 NodeGuid=A1A2A3A4A5A6A7A8A9A0AAABACADAEAF CustomProperties Pin (PinId=AA000001111122223333444455556666,PinName="self",PinFriendlyName=NSLOCTEXT("K2Node", "Target", "Target"),PinToolTip="Target\nCChar BPLibrary Object Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/CdryxCharUModule.CCharBPLibrary"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,DefaultObject="/Script/CdryxCharUModule.Default__CCharBPLibrary",PersistentGuid=00000000000000000000000000000000,bHidden=True,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=AA000002222233334444555566667777,PinName="worldContextObject",PinToolTip="World Context Object\nObject Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/CoreUObject.Object"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=True,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=AA000003333344445555666677778888,PinName="ReturnValue",PinToolTip="Return Value\nPawn Object Reference",Direction="EGPD_Output",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/Engine.Pawn"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) End Object Begin Object Class="/Script/BlueprintGraph.K2Node_CallFunction" Name="K2Node_CallFunction_1" bIsPureFunc=True FunctionReference=(MemberParent=/Script/CoreUObject.Class'"/Script/CdryxCharUModule.CCharBPLibrary"',MemberName="retrieveTeamAttitude_") NodePosX=400 NodePosY=0 NodeGuid=B1B2B3B4B5B6B7B8B9B0BABBBCBDBEBF CustomProperties Pin (PinId=BB000001111122223333444455556666,PinName="self",PinFriendlyName=NSLOCTEXT("K2Node", "Target", "Target"),PinToolTip="Target\nCChar BPLibrary Object Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/CdryxCharUModule.CCharBPLibrary"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,DefaultObject="/Script/CdryxCharUModule.Default__CCharBPLibrary",PersistentGuid=00000000000000000000000000000000,bHidden=True,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=BB000002222233334444555566667777,PinName="worldContextObject",PinToolTip="World Context Object\nObject Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/CoreUObject.Object"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=True,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=BB000003333344445555666677778888,PinName="source",PinToolTip="Source\nPawn Object Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/Engine.Pawn"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=BB000004444455556666777788889999,PinName="destination",PinToolTip="Destination\nPawn Object Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/Engine.Pawn"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=BB000005555566667777888899990000,PinName="ReturnValue",PinToolTip="Return Value\nETeamAttitude Enum",Direction="EGPD_Output",PinType.PinCategory="byte",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Enum'"/Script/AIModule.ETeamAttitude"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) End Object Begin Object Class="/Script/BlueprintGraph.K2Node_CallFunction" Name="K2Node_CallFunction_2" bIsPureFunc=True FunctionReference=(MemberParent=/Script/CoreUObject.Class'"/Script/CdryxCharUModule.CCharBPLibrary"',MemberName="retrieveMainTag") NodePosX=0 NodePosY=200 NodeGuid=C1C2C3C4C5C6C7C8C9C0CACBCCCDCECF CustomProperties Pin (PinId=CC000001111122223333444455556666,PinName="self",PinFriendlyName=NSLOCTEXT("K2Node", "Target", "Target"),PinToolTip="Target\nCChar BPLibrary Object Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/CdryxCharUModule.CCharBPLibrary"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,DefaultObject="/Script/CdryxCharUModule.Default__CCharBPLibrary",PersistentGuid=00000000000000000000000000000000,bHidden=True,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=CC000002222233334444555566667777,PinName="worldContextObject",PinToolTip="World Context Object\nObject Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/CoreUObject.Object"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=True,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=CC000003333344445555666677778888,PinName="source",PinToolTip="Source\nActor Object Reference",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=/Script/CoreUObject.Class'"/Script/Engine.Actor"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) CustomProperties Pin (PinId=CC000004444455556666777788889999,PinName="ReturnValue",PinToolTip="Return Value\nName",Direction="EGPD_Output",PinType.PinCategory="name",PinType.PinSubCategory="",PinType.PinSubCategoryObject=None,PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,) End Object https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/diagrams/index.html Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/diagrams/index.html Overview Visual diagrams illustrating the internal architecture and runtime behavior of CCHARUMODULE. 1. Class Hierarchy & Component Composition Base class inheritance tree showing which components each level adds. All base classes implement IGenericTeamAgentInterface (via UCInteractionComponent) and ICCommonActor. https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/baseclasses/index.html Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/baseclasses/index.html Overview The module provides a hierarchy of pre-assembled base classes. Each class automatically creates and wires its components in the constructor via UCInitializerComponent::prepare_CSTR_* static methods. All base classes implement IGenericTeamAgentInterface (delegated to UCInteractionComponent) and the framework’s ICCommonActor interface. ACActor Lightweight actor base. Inherits AActor. Components: root scene, initializer, debug, static mesh, interaction, select, skill. https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/components/index.html Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/components/index.html Overview All components follow the same lifecycle pattern: created in the constructor via UCInitializerComponent::prepare_CSTR_*, initialized at runtime via init() with a UCActorInformation*, and reset via reset(). Dynamic delegate binding/unbinding is managed through boundDynamic() / unboundDynamic(). Component List Component Category Description ICInputReceiver Input Interface for receiving input events via FCInputStruct slots UCActionMappingComponent Input Enhanced Input action mapping with runtime context creation UCAIPerceptionStimuliSourceComponent AI Perception stimuli source with activation-based registration UCAutomationComponent AI Circular command queue for AI automation sequences UCCameraComponent Camera Camera with custom init/tick/reset lambdas UCCapsuleComponent Physics Collision capsule auto-sized from skeletal mesh bounds UCCharacterMovementComponent Movement Character movement with jump state machine UCCombotterComponent Combat Melee/range/block state machines driving montage and damage UCCompassComponent UI 3D compass widget tracking activated actors on screen UCDamageEmissionContainer Data Data container for outgoing damage information UCDamageReceptionContainer Data Data container for incoming damage information UCDebugComponent Debug Debug overlay widget with world-space or screen-space rendering UCFloatingMovementComponent Movement Floating pawn movement with ground-following line trace UCFOWComponent Rendering Fog of War renderer with actor/room agents and raycasting UCInitializerComponent Lifecycle Central orchestrator driving the initialization cascade for all other components UCInteractionComponent Gameplay Capsule-based overlap interaction with team filtering UCLifeComponent Combat Health and damage management with life bar widget UCMappingManager Input GameInstance subsystem storing the active input mapping context UCMinimapComponent UI Top-down scene capture for minimap rendering UCNavigationInvokerComponent AI Dynamic navmesh generation around the actor UCProjectileMovementComponent Combat Projectile movement with bend-time-to-speed curve UCSelectComponent Gameplay Decal-based permanent and temporary selection indicator UCSkeletalMeshComponent Rendering Skeletal mesh with modular character and animation support UCSkillComponent Gameplay Skill list management and skill dock widget UCSpringArmComponent Camera Spring arm with custom init/tick/reset lambdas UCStaticMeshComponent Rendering Static mesh with actor event-driven visibility UCTurnByTurnComponent Combat Turn-by-turn combat orchestrator with multi-state machine https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/data/index.html Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/data/index.html Overview Configuration is entirely data-driven via DataTable rows. FCCharacterDetailMaker is the central structure defining everything about an actor. FCNPCMaker groups actors for the spawner. FCPlayerMakerStruct references a character maker for player creation. UCActorInformation holds runtime state. FCCharacterDetailMaker Main DataTable row structure (FTableRowBase). Defines actor class, visuals, animations, combat, AI, skills, interaction, biome constraints and more. https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/spawner/index.html Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/spawner/index.html Overview Two spawner systems manage actor lifecycle: ACActorSpawner for NPCs/objects and ACPlayerSpawner for players. Both inherit from ACAbstractSpawner (from CCOREUMODULE). The actor spawner uses a cell-based pooling pipeline that activates/deactivates actors based on proximity to a tracked pawn. ACActorSpawner Main actor spawner placed in the level. Reads a FCNPCMaker DataTable row, creates a UCActormaker, and drives the generation loop on tick. Requires a ANavMeshBoundsVolume and ARecastNavMesh in the level. https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/animation/index.html Sat, 20 Jul 2024 21:09:28 +0200 https://doc.cdryx.net/CdryxAIOUPlugin/modules/ccharumodule/animation/index.html Overview UCAnimInstance is the custom UAnimInstance subclass used by all characters. It provides a typed variable system for driving AnimBlueprint state, automatic computation of speed/direction/lean/slope, montage priority management, and integration with the combat state machines. CMontageNotifier defines the AnimNotify classes used for combat events. UCAnimInstance Name Description readAnimBoolVar / writeAnimBoolVar Read/write typed bool variables (falling, accelerating, sprinting, fighting, top-viewing, interrupted) readAnimFloatVar / writeAnimFloatVar Read/write typed float variables (speed, direction, slope angle, lean angle, roll, pitch, yaw) readAnimFNameVar / writeAnimFNameVar Read/write typed FName variables readAnimFVectorVar / writeAnimFVectorVar Read/write typed FVector variables readAnimFTransformVar / writeAnimFTransformVar Read/write typed FTransform variables cdryxAnimSequenceMap Named animation sequences from FCCharacterDetailMaker::animSequenceMap cdryxBlendSpaceMap Named blendspaces from FCCharacterDetailMaker::blendspaceMap setPriority Sets montage priority for the priority-based playback system comparePriority Compares two montage priorities (used by ICAnimePrioritizer) // Typed variable system — used in AnimBlueprint via BlueprintCallable getters: animInstance->writeAnimBoolVar(CAnimBoolVar::CDRYX_FIGHTING, true); bool fighting = animInstance->readAnimBoolVar(CAnimBoolVar::CDRYX_FIGHTING); float speed = animInstance->readAnimFloatVar(CAnimFloatVar::CDRYX_SPEED); float direction = animInstance->readAnimFloatVar(CAnimFloatVar::CDRYX_DIRECTION); // FName-based variants for custom variables (not in the enum): animInstance->writeAnimBoolVar_(FName("MY_CUSTOM_BOOL"), true); bool custom = animInstance->readAnimBoolVar_(FName("MY_CUSTOM_BOOL")); // Every write triggers moveOnAllSimpleStateMachine() to advance combat state machines. Bool Variables (CAnimBoolVar) Name Description CDRYX_FALLING True when the movement component reports falling CDRYX_ACCELERATING True when current acceleration is non-zero CDRYX_SPRINTING Sprint state CDRYX_FIGHTING Fight mode active CDRYX_TOPVIEWING True when spring arm does not inherit pitch (top-view mode) CDRYX_INTERRUPTED Set by C_INTERRUPTED_AN notify window Float Variables (CAnimFloatVar) Name Description CDRYX_SPEED 2D velocity magnitude CDRYX_DIRECTION Movement direction relative to actor rotation CDRYX_SLOPE_ANGLE Pitch angle between previous and current location (terrain slope) CDRYX_LEAN_ANGLE Yaw delta rate for leaning in turns CDRYX_ROLL / CDRYX_PITCH / CDRYX_YAW Aim rotation delta relative to actor rotation Template Sequence Names (ECAnimeTemplateSequenceName) Named slots for the AnimBlueprint template CdryxTemplateAnimBP: