Overview :: Catur Documentation

Actor

Sat, 20 Jul 2024 21:09:28 +0200

An Actor is the simplest entity on a board: a placed object with an interaction volume, no skeletal mesh, no AI, no health. Added with addActor(tag, skills, lambda). Setters Setter Effect actorClass(class) The ACActor subclass spawned for this entity. Mandatory: an entity whose class is unset is skipped at spawn time with a warning. basic(...) Sets the identity block → FCBP_ACPBasic. interaction(...) Sets the interaction block → FCBP_ActorInteraction. Example FCBP_Actor actor = FCBP_Actor() .actorClass(retrieveClass("MY_ACTOR_CLASS")) .basic(FCBP_ACPBasic() .mainTag("BLOCK") .minScale(1.0f) .maxScale(1.0f)) .interaction(FCBP_ActorInteraction() .interactWithPlayerOnly(true) .interactOnceOnly(true));

Pawn

Sat, 20 Jul 2024 21:09:28 +0200

A Pawn is a moving, animated, AI-driven entity with health. It extends the actor with a skeletal mesh, AI, lifecycle and floating movement. Added with addPawn(tag, skills, lambda). Setters Setter Effect actorClass(class) The ACPawn subclass spawned for this pawn. basic(...) Identity block → FCBP_ACPBasic. skeletal(...) Mesh and animation → FCBP_CPSkeletal. behavior(...) Attack behavior → FCBP_CPBehavior. ai(...) AI, team, behavior tree → FCBP_CPAI. lifecycle(...) Health and damage → FCBP_CPLifecycle. fogOfWar(...) Fog reveal → FCBP_FogOfWarRevealer. movement(...) Floating movement → FCBP_PMovement. interaction(...) Interaction rules → FCBP_PawnInteraction. Example FCBP_Pawn pawn = FCBP_Pawn() .actorClass(ACPawn::StaticClass()) .basic(FCBP_ACPBasic() .mainTag("ENEMY") .minScale(0.9f) .maxScale(1.1f)) .skeletal(FCBP_CPSkeletal() .skeletalMesh(retrieveAsset("ENEMY_MESH")) .physicsAsset(retrieveAsset("ENEMY_PHYSICS")) .animClass(retrieveClass("ENEMY_ANIM_CLASS"))) .behavior(FCBP_CPBehavior() .meleeAttackBehavior(FCBP_CPMeleeAttackBehavior() .allowComboLoop(true))) .ai(FCBP_CPAI() .team(1) .aiClass(ACAIController::StaticClass()) .behaviorTree(retrieveAsset("ENEMY_BT"))) .lifecycle(FCBP_CPLifecycle() .maxLife(100.0f) .damage(5.0f) .blockArmor(3.0f) .damageOn({ETeamAttitude::Hostile})) .fogOfWar(FCBP_FogOfWarRevealer() .lineOfSightSizeMeter(4.5f) .revealedAreaSizeMeter(6.5f)) .movement(FCBP_PMovement() .maxWalkSpeed(6.0f)) .interaction(FCBP_PawnInteraction() .interactWithPlayerOnly(true));

Character

Sat, 20 Jul 2024 21:09:28 +0200

A Character is a pawn that uses the character movement component (walk, step, jump). It adds a landed hook on top of the pawn. Added with addCharacter(tag, skills, lambda). Setters Setter Effect actorClass(class) The ACCharacter subclass spawned for this character. basic(...) Identity block → FCBP_ACPBasic. skeletal(...) Mesh and animation → FCBP_CPSkeletal. behavior(...) Attack behavior → FCBP_CPBehavior. ai(...) AI, team, behavior tree → FCBP_CPAI. lifecycle(...) Health and damage → FCBP_CPLifecycle. fogOfWar(...) Fog reveal → FCBP_FogOfWarRevealer. movement(...) Character movement → FCBP_CMovement. interaction(...) Interaction rules → FCBP_CharacterInteraction. Example FCBP_Character character = FCBP_Character() .actorClass(ACCharacter::StaticClass()) .basic(FCBP_ACPBasic() .mainTag("GUARD") .minScale(0.9f) .maxScale(1.1f)) .skeletal(FCBP_CPSkeletal() .skeletalMesh(retrieveAsset("GUARD_MESH")) .physicsAsset(retrieveAsset("GUARD_PHYSICS")) .animClass(retrieveClass("GUARD_ANIM_CLASS"))) .behavior(FCBP_CPBehavior() .meleeAttackBehavior(FCBP_CPMeleeAttackBehavior() .allowComboLoop(true))) .ai(FCBP_CPAI() .team(1) .aiClass(ACAIController::StaticClass()) .behaviorTree(retrieveAsset("ENEMY_BT"))) .lifecycle(FCBP_CPLifecycle() .maxLife(200.0f) .damage(10.0f) .blockArmor(3.0f) .damageOn({ETeamAttitude::Hostile})) .fogOfWar(FCBP_FogOfWarRevealer() .lineOfSightSizeMeter(4.5f) .revealedAreaSizeMeter(6.5f)) .movement(FCBP_CMovement() .maxWalkSpeed(6.0f) .maxStepHeight(45.0f) .jumpZVelocity(6.3f)) .interaction(FCBP_CharacterInteraction() .interactWithPlayerOnly(true));

Player

Sat, 20 Jul 2024 21:09:28 +0200

The Player is the entity the user controls. Added with addPlayer1ST(skills, lambda) (first-person) or the fly variant. Note: its AI and “specific” blocks exist internally but are not exposed as fluent setters. Setters Setter Effect actorClass(class) The pawn subclass spawned for the player (must implement CCommonPlayer). basic(...) Identity block → FCBP_ACPBasic. skeletal(...) Mesh and animation → FCBP_CPSkeletal. behavior(...) Attack behavior → FCBP_CPBehavior. interaction(...) Interaction rules → FCBP_PlayerInteraction. lifecycle(...) Health and damage → FCBP_CPLifecycle. movement(...) Character movement → FCBP_CMovement. fogOfWar(...) Fog reveal → FCBP_FogOfWarRevealer. Example FCBP_Player player = FCBP_Player() .actorClass(ACPlayer1STCharacter::StaticClass()) .basic(FCBP_ACPBasic() .mainTag("PLAYER") .minScale(1.0f) .maxScale(1.0f)) .skeletal(FCBP_CPSkeletal() .skeletalMesh(retrieveAsset("PLAYER_MESH")) .physicsAsset(retrieveAsset("PLAYER_PHYSICS")) .animClass(retrieveClass("PLAYER_ANIM_CLASS"))) .behavior(FCBP_CPBehavior() .meleeAttackBehavior(FCBP_CPMeleeAttackBehavior() .allowComboLoop(true))) .interaction(FCBP_PlayerInteraction() .interactWithPlayerOnly(false)) .lifecycle(FCBP_CPLifecycle() .maxLife(100.0f) .damage(5.0f) .blockArmor(3.0f) .damageOn({ETeamAttitude::Hostile})) .movement(FCBP_CMovement() .maxWalkSpeed(6.0f) .maxStepHeight(45.0f) .jumpZVelocity(6.3f)) .fogOfWar(FCBP_FogOfWarRevealer() .lineOfSightSizeMeter(4.5f) .revealedAreaSizeMeter(6.5f));

Side2D

Sat, 20 Jul 2024 21:09:28 +0200

A Side2D board is a 2D grid level driven by a level asset, where grid character keys spawn NPCs. Added with addSide2D(skills, lambda). Setters Setter Effect sideAsset(UCSide2DLevelAsset*) The level asset holding the grid and block definitions. npcs(TArray) Maps grid keys to NPC tags → FCBP_ACPSide2DRule. The hook onPlayerOverlapBlockSkill is a skill, documented in the Skills section. Example FCBP_Side2D side2D = FCBP_Side2D() .sideAsset(retrieveAsset("MY_SIDE2D")) .npcs({ {"C", "LIMACE"}, {"I", "MUSHROOM"}, }); (FCBP_Side2D has only these two setters; both are shown.)

World

Sat, 20 Jul 2024 21:09:28 +0200

The World describes a procedural 3D terrain (height from noise), its edges, fog of war, minimap and generation parameters. Passed to the board as the world block. Setters Setter Effect edgeType(ECEdgeType) How the world border is shaped. material(UMaterialInterface*) Material applied to the terrain mesh. worldTopography(UCNoiseDataAsset*) Mandatory base noise defining terrain height. clusterTopography(UCNoiseDataAsset*) Optional noise for room-cluster areas. clusterShiftTopography(UCNoiseDataAsset*) Optional shift noise for non-room cluster areas. roomAndCorridorTopography(UCNoiseDataAsset*) Optional shift noise for rooms and corridors. fogOfWar(FCBP_FogOfWar) Fog of war settings → FCBP_FogOfWar. worldEffector(FCBP_WorldEffector) Generation parameters → FCBP_WorldEffector. shadowEffector(FCBP_ShadowEffector) Shadow settings → FCBP_ShadowEffector. roomAndCorridorSoftener(EAlphaBlendOption) Blend curve smoothing room/corridor edges into the terrain. The map (minimap) block exists but has no fluent setter yet.

Common / non-fluent

Sat, 20 Jul 2024 21:09:28 +0200

These structs are part of the game board definition but have no fluent setters. They are filled directly by their fields (or by a constructor). They are listed here for completeness of the grammar. Structs without fluent setters Struct How it is filled Role FCBP_GameCommon fields Shared board settings: HUD widget classes (debug, compass, interaction, dialog, skill, resource, life, llm dialog, minimap) + metadata maps. FCBP_CommonMetadata fields label, icon Base of all metadata structs. FCBP_SkillMetadata fields cooldown, baseColor (+ base) Display metadata for a skill. FCBP_ResourceMetadata base fields only Display metadata for a resource. FCBP_CharMetadata base fields only Display metadata for a character. FCBP_RoomMetadata base fields only Display metadata for a room. FCBP_ACPNPC fields characters, pawns, actors Container grouping the NPCs of a board (filled by the addXxx calls). FCBP_Inventory fields name, inventoryClass One inventory item definition. FCBP_Skill fields name + lambda/delegate A skill definition (see the Skills section). FCBP_Map fields Minimap meshes and tangent force. FCBP_Biome fields biomeTopography, boundaries Biome definition driven by a noise asset. FCBP_BiomeBound fields name, noiseLowerValue, noiseUpperValue One named noise range inside a biome. FCBP_Misc constructor Display/quality settings (resolution, frame rate, AA, quality levels). FCBP_GameStruct internal Runtime DataTable wiring, created by storeNewGameBoard (not authored by hand). Example (field-based, no fluent) FCBP_GameCommon gameCommon; gameCommon.lifeWidgetClass = myLifeWidget; gameCommon.skillMetadata.Add("FIREBALL", FCBP_SkillMetadata());