6.6 KiB
6.6 KiB
xiandie
《衔蝶》开发代码
说明
- animation frames：res://config/animation/entity_sprite_frames.tres
插件
ProAnimatedSprite2D
插件路径：addons/property-inspector/pro_animation_sprite2d
ProAnimatedSprite2D，增强 AnimatedSprite2D 的表现，在其基础上增加：
- 播放+移动：播放特定动画时自动移动，可配置移速
- 播放某动画后自动跳转：播放一个动画结束后，自动播放另一个
- 自动跳转可以设置循环播放次数，若干次后再跳转
- 跳转前可以等待 wait_time 时长
其中：
- action configs 配置动画跳转逻辑
- move configs 配置播放特定动画时的移动速度
- ProAnimatedSprite2D 配置项跳过保存默认值，有利于统一控制、变更默认值
Ground 与 GroundLoader
- 正常游戏：Main -> GroundLoader -> Ground
- 开发阶段：直接编辑 Ground
整体说明
GroundLoader 加载/切换 Ground 时，分为上下两段转场：
- 上半段（旧场景变黑）：先暂停旧 ground，即在转场黑屏过程中旧的 ground 会 paused
- 下半段（新场景出现）：先暂停，在完全出现后再运行 【特殊注意⚠️】
- AnimationPlayer 的 process_mode 并非 inderited，而是 pausable。这意味着 AnimationPlayer 的 _on_ground_ready 在转场时仍旧可以直接运行。
- CameraFocusMarker 也需要如此，以确保镜头快速拉到指定位置
- 盒子猫游戏中的 canvas layer
- 一些 npc、player 大运行脚本会被中断。如果想让它们仍旧运行，需设置为 pausable。
Ground 说明
AnimationPlayer：每个 Ground 都有一个 AnimationPlayer，脚本继承自定义的 AnimationRoot
主要功能说明：
- 正常的 AnimationPlayer 功能
- oneshot_animation 场景首次加载时播放的 animation
主要方法与数据说明：
- _default_data() : 本场景的默认存档数据
- _on_ground_ready(): 在父节点 Ground 加载完成后回调
- set_data(property: StringName, value: Variant)：用于设置需要存档的数据
- ground_archive：存档数据
Entity 说明
位置：res://scene/entity/
子目录说明：
- ambient：光照
- general：音效等
- partical：粒子效果
- ux：用户交互
主要类型说明：
- ambush：触发区域，触发后执行回调
- 可以配置是否一次性
- 可配置触发方式：enter, area_enter, interact
- 可在场景加载时触发
- 触发效果有：播放对话（期间锁定玩家）；播放动画；回调方法（AnimationPlayer 的方法，注意“_”开头的方法会被忽略）
- inspectable：可在检阅窗口进行审视的物品，可以附加文案
- local_inspectable：运镜+检阅，无需检阅窗口
- note：显示文案
- 显示方式：os（玩家头顶气泡），ballon（下方字幕，可播放配音）
- npc
- portal：传送门
- 名称有: left（默认）, right（默认）, 1, 2, 3, ...
- 关键参数：targer_scene 与 target_portal（target_portal 为 none 时不启用）
- 三种模式：default（通道）；opened（打开的门）；locked（锁定的门）；对应不同图标与操作音效
- 锁定的门可以配置启用钥匙（prop_key），可在使用后自动消耗该钥匙
AimationPlayer Tool Button 说明
存档 Tool Button
- 全局 ArchiveManager 与 EventManager 的存档变量都在 Debug Global Data 中
- 场景本地状态在 Debug Ground Data 中
自动生成变量名 Tool Button
func _parse_node(ground_node, node:Node, existing_vars:Dictionary, code_lines:PackedStringArray, created_vars):
# 0. filter unique mark
# 1. create `var snake_case_variable_name = $"../xx/yy/NodeName"`
# 2. create `var snake_case_variable_name = $"../xx/yy/NodeName"`
if not node.unique_name_in_owner or ground_node.get_node_or_null("%"+node.name) == null:
# 只读取 unique 标记过的节点; node.unique_name_in_owner 参数不可靠，需要实际检查
return
var var_name = node.name.to_snake_case()
if existing_vars.has(var_name):
return
created_vars.append(var_name)
code_lines.insert(region_start_id + 1, "var " + var_name + ": "+ str(node.get_class()))
func_line_id += 1
code_lines.insert(func_line_id + 1, "\t" + var_name +" = %\"" + node.name +"\"")
- 只读取 unique 标记过的变量（%）
线索笔记说明
存档结构
- 存档命名为："save"+三位数字
- 如果不足三位数字，则会忽略；超过三位数字不会忽略，可以正常读取
- 这是为了方便多存档功能进行文本排序等
- 开发阶段 debug 存档：save000
- 开发阶段 index 页面进入的游戏存档：save001
- 发行后，玩家游戏过程中，自动保存的存档编号范围（最多 10 个，循环保存）：000-019
- 发行后，玩家游戏过程中，手动保存的存档编号范围（最多 10 个栏位）：050-059
- 发行后，玩家游戏过程中最多有以上 20 个存档
每个场景都有一份 GroundArchive 存档，通过 ArchiveManager.archive.ground_archive() 可以获得。
current_scene 是通过 GroundLoader 加载的，在 ground loader 加载 ground 时，会先更新 archive 的 current scene，然后加载 ground。
重大更新日志（功能）
- Sign 触发机制
- 唯一触发器，关注各节点唯一占有 occupied 状态，与全局 hold/unhold （禁止操作）状态
- 管理图标贴图（unrevealed / matched / ...）与位置
- GroundArchive：场景内 namespace 隔离
- 内部需要保证节点名 unique
- 基础节点：Inspectable，Ambush，Note，Interactable，Closeup，Npc
- [#ban_skip] 与 IGNORE_INPUT : 前者 debug 可跳过，后者总不可跳过
- PropHud 切换与点击展示
- 左键点击展开 Hud
- 右键点击检阅道具
- SignSnapper 拉动机制
- 自动锁定玩家操作，调用 walk_to 指定位置
- 自动优化范围：忽略小范围移动以防抽动，最低活动距离
- ReenterLock 机制
- 可重入锁
- Editor 中运行可 Debug 输出调用位置（调用 lock 的代码文件&代码行）
- Vibe Sfx & Manager
- 全局音效控制
- 影响 SignSnapper 的等待时长（如 Boss 战时加快节奏）
- 转场 process 机制优化：暂停 & AnimationPlayer 保持运行
- EventManager 控制事件，使用 Event2D 控制绑定关系
- Vibe Control 控制氛围情绪音乐