[单脚本][MyClearGuns] 开箱即用的枪械编辑器，新增开火轨迹、支持IK锚点！

叽里咕噜小胡桃 · 发表于 2023-5-28 18:21:46

本帖最后由叽里咕噜小胡桃于 2024-10-12 22:12 编辑

还在苦恼想做射击游戏却不知道如何开始吗？
试试MyClearGuns吧！在游戏里轻松创造你心仪的枪械！
Json序列存储枪械，众多接口方便你快速接入自己游戏！
1. 安装部署MyClearGuns

MyClearGuns.ts (121.8 KB, 下载次数: 165)

2024-10-12 22:12 上传

点击文件名下载附件
* 更新日志：
* 版本： * 版本： v0.1.14 2024.10.12
* 1. 尝试修复MyClearGuns打不了NPC怪物的bug，感谢论坛老哥 @吖嗡嗡的反馈
* v0.1.13 2024.06.18
* 1. 添加IK兼容，在枪械预制体里可以加上IK锚点，装备枪械后会自动开启IK，换弹时会自动关闭IK

* 2. 去除补子弹成功了会触发换弹完成onClientReloadComplete的回调，改为onAddAmmo回调
* 3. 修复按比例补子弹时，没有正确补上的bug

* 历史版本：
* v0.1.12 2024.06.14
* 1. 表现层的RPC设置为不可靠RPC，降低RPC同步压力
* 2. 修改击中音效、适当扩大子弹击中场景的特效
*v0.1.11 2024.03.27
* 1. 尝试添加开火轨迹，以获得更好的表现效果，并加入到配置表里
*v0.1.10 2024.03.13
* 1. 尝试添加开火镜头晃动，以获得更好的体验
* 2. 利用枪焰标记开火射线的初始位置，如果一把枪有枪焰即FireEffect的特效，射线将会从这个特效的位置开始
*v0.1.9 2024.03.06
* 1. 尝试添加高级动画模式兼容(030生效)
* 2. 尝试添加持枪姿态，现在有更好的表现效果了
* 3. 修复换弹时触发枪焰的bug
* 4. 修复PIE下按X隐藏UI后无法再唤起的bug
*v0.1.8 2023.12.23
* 1. 尝试修复连点器情况下超越全自动的射速
* 2. 修整方法和事件，并给事件添加参数、回调
* 3. 尝试修复开火听不到枪声的bug
* 4. 尝试在不大幅增加rpc压力的情况下加入动画广播、枪焰特效
* 5. 添加设定，在非编辑器PIE运行态下不会打开EditorUI，即使开启了这个选项
* 6. 修改事件方法为静态，以减少初始化时序问题
* 7. 新增双端获取玩家手里枪名的方法getPlayerGunName
* 8. 新增当枪械guid为预制体时，开火时会自动播放含有FireEffect的特效

下载脚本，导入到工程内容中，拖一个脚本到场景里即可
在其他脚本中使用 MyClearGuns.instance.方法名就可以调用方法
2. 开始之前，建议调整一下这些
摄像机选择TPS过肩视角，关闭真实效果

相对旋转一定要清零

其他的适当的把距离拉远 fov拉大一些看个人习惯就好
最好在屏幕中间加个准星~射击游戏没有准星可太难了
3. 脚本属性讲解
编辑状态：开启后进游戏可以看到枪械编辑UI，正式发布的话可以把这个关掉
优先加载：这里填需要优先加载的guid，可以通过工具栏的获取guid获取到，进入优先加载后进游戏给枪就不会卡
音效距离系数：音效广播距离的全局缩放裁剪系数，可通过调整该系数降低rpc压力
特效距离系数：特效广播距离的全局缩放裁剪系数，可通过调整该系数降低rpc压力
距离系数越低，音效、特效被裁减的距离就越近，即每次开火需要同步的客户端数量变少了
枪械配置：序列化的json串可以放在这里，在运行时可以通过接口获取到这里保存的枪械
4. 开启编辑模式
对象管理器中选中MyClearGuns，点开它的编辑状态属性，然后直接运行
注意：024目前有丢失脚本属性配置的bug，建议大家的json串等配置另行保存哦!~

5. 枪械属性讲解
这里列举的是一个射线枪械所需要的较为简略的属性了，这些往往是射击反馈体验比较看重的参数
因为希望开发者们可以快点用起来，不用搞那么多弯弯绕绕，所以会比较简略~
音效通用单元：音效资源guid|音量|内径|外径
· 音量：声音的大小
· 内径：单位米，1=1个正方体的边长，在这个内径内的声音不会衰减
· 外径：单位米，音量从内径边缘到外径边缘衰减至0
5.1 枪械名称
枪械名称：唯一，这个是用其他接口调出这把枪的唯一标识
5.2 开火之前的数据
这些是开火之前需要确定的数据
枪械模型：枪械模型的guid
偏移： 枪械模型在右手的偏移量
旋转：枪械模型在右手的旋转量
缩放：枪械模型在右手的缩放量
掏枪动画：获取该枪时会播放的动画
掏枪音效：获取该枪时会播放的音效，音效资源guid|音量|内径|外径
出枪时间：掏枪出来时，枪械模型显示的时间，秒
5.3 开火属性数据
这些是决定枪械开火时的表现数据
有效射程：枪械能造成伤害的范围，单位米，1=1个正方体的边长，射程内有伤害，射程外无伤害
单发伤害：单颗弹丸击中目标能造成的伤害
弹丸数量：每次开火能射出的弹丸数量
水平后座：每开一枪准星向左或右偏移的最大后座力
垂直后座：每开一枪准星向上偏移的最大后座力
散射程度：后座都为0时，着弹点离准星最大的散射偏移量，圆形范围内随机散布
全自动：是否为全自动，开启时按下开火，松开停火，关闭时需要在射击间隔之外按开火发射
射击间隔：每次射击之间的间隔，单位毫秒
开火动画：每次射击时会播放的动画guid
开火音效：每次开火时的音效，音效资源guid|音量|内径|外径
5.4 换弹属性数据
这些是决定枪械换弹时的表现数据
到手载弹：枪械刚装备到手上时的子弹数
弹匣载弹：枪械每次换弹，弹匣内理论最大子弹数
到手备弹：枪械刚装备到手上时，备弹的数量
最大备弹：枪械能被补给的最大子弹数，可以比到手备弹更大
换弹耗时：换弹所需要的时间，单位秒
换弹动画：换弹时会播放的动画
开始音效：开始换弹的音效
完成音效：换弹完成时的音效
5.5 整理了一些常用的还行的动画数据
适用于步枪射击的动画： 80483，80484，97181，97179(端枪腰射)
适用于步枪换弹的动画：33561(ak反手拉栓)，14014(有点像m4拉机柄)，49093(直接插弹匣)，80479(向侧枪匣装填)，99960(换弹+拉机柄)，102367(有点像awp换弹)，4171(弹匣在握把后面的换弹)
适用于手枪射击的动画：20253，20283 (后坐力较大)，80589，97175，80586(腰间)，81687，81690，99647
适用于手枪换弹的动画：20239(上弹匣)，14018(拉套筒，上弹匣)，14021(上弹匣，不过弹匣口略朝自己)，80588(快扣弹匣)，81691
6. 工具栏功能按钮
界面显隐：快捷键X，编辑视窗的显示、取消显示
序列化：快捷键G，将左侧的枪械属性序列化为json串，到下方输入框
反序列化：快捷键H，将下方输入框内的json传反序列化为左侧的枪械属性
获取GUID：将下方输入框内的json串中的guid提取出来
装备枪械：快捷键E，将左侧的枪械属性装备到角色手中
开火：快捷键F，用角色手中的枪械开火，需要先装备枪械
换弹：快捷键R，给角色手中的枪械换弹
7. 如何快速接入
1. 将保存好的json串配置在枪械配置里

2. 建议关闭编辑状态

3. 优先加载填入guid
4. 给UI绑定以下接口
开火按钮：这里不一定要用按钮，也可以用摇杆，当摇杆按下/松开

// 开火按钮按下时调用ClientStartShoot()开火

this.shootBtn.onPressed.add(() => {

    MyClearGuns.instance.ClientStartShoot();

})

// 开火按钮松开时调用ClientStopShoot()停止开火

this.shootBtn.onReleased.add(() => {

    MyClearGuns.instance.ClientStopShoot();

})

换弹按钮

// 换弹按钮按下时调用ClientReloadAmmo()进行换弹

this.ReloadBtn.onClicked.add(() => {

    MyClearGuns.instance.ClientReloadAmmo();

})

5. 写一个随机给枪的脚本，挂载触发器下

import MyClearGuns from "./MyClearGuns";



@Core.Class

export default class NewScript extends Core.Script {



    /** 当脚本被实例后，会在第一帧更新前调用此函数 */

    protected onStart(): void {

        if (SystemUtil.isServer()) {

            let trr = this.gameObject as Gameplay.Trigger;

            trr.onEnter.add((gobj) => {

                if (gobj instanceof Gameplay.Character) {

                    MyClearGuns.instance.ServerGiveRandomGun(gobj.player);

                }

            })

        }

    }

}

走到这个触发器的时候就会随机获取一把枪械，这样就按下开火键就可以开火了

6. 可以在UI脚本或C端脚本里调用onClientOneShootComplete()等事件接口，在里面接入UI相关的信息

// 当客户端成功射击一次时

MyClearGuns.instance.onClientOneShootComplete.push((curAmmo, preAmmo) => {

    // 这里对UI进行设置，比如设置当前的子弹数curAmmo和备弹数preAmmo

})



// 当客户端换弹完成时

MyClearGuns.instance.onClientReloadComplete.push((curAmmo, preAmmo) => {

    // 这里对UI进行设置，比如当前子弹数curAmmo和备弹数preAmmo

})



// 当客户端拿到枪时

MyClearGuns.instance.onClientEquipedGun.push((gunName, curAmmo, preAmmo) => {

    // 这里对UI进行设置，比如枪名gunName、当前子弹数curAmmo和备弹数preAmmo



})

7. 找到checkIFFriendly事件并注入敌我判定逻辑
新建脚本，调用checkIFFriendly()事件，可以使用MyClearCamp进行队友判定，如果只是单人竞技的话直接返回false开干吧

MyClearGuns.instance.checkIfFriendly.push((ID1,ID2)=>{

    return MyClearCamp.isFriendly(ID1, ID2)

})

8. 接入MyClearHp或玩家系统，进行伤害实现
新建脚本，调用ServerDamageChar()事件，在这里接入你的伤害实现逻辑

MyClearGuns.instance.ServerDamageChar.push((AID, VID, damage, Headshot)=>{

    MyClearHP.ServerChangeCharCurHP(AID, VID, -damage)

})

9. 到这一步，你的项目基本成功接入了MyClearGuns枪械编辑器，并且可以在游戏状态下使用这些枪械了
8. 实用接口与拓展
这里还提供了一些实用的接口，方便大家进行接入和二创~
8.1 功能方法

方法	功能	输入	返回
ClientStartShoot()	[纯客户端] 持续开火，包含全自动和半自动，没有弹速、下坠，纯射线，用ClientStopShoot()停火
ClientStopShoot()	[纯客户端] 停火
ClientReloadAmmo()	[纯客户端] 换弹，换弹会停止射击，且换弹期间无法射
ClientAddAmmo(player: Player, AmmoCount?: number)	[双端可用] 给指定玩家添加子弹，如果补成功了会触发换弹完成onClientReloadComplete回调
ServerGiveGun(player: Player, gunName: string)	[纯服务器] 给玩家装备枪械，是枪械库里有的枪
ServerGiveRandomGun(player: Player, guns?: string[])	[纯服务器] 给玩家随机一把枪，可选定范围
getPlayerGunName(player?: Player)	[双端] 获取玩家手里装备着的枪名，C端只获取自己

8.2 事件接口

事件	描述	变量	备注
onPlayerShoot: ((PlayerId: string) => void)	[纯服务器] 检测到玩家开火
onClientEquipedGun((gunName: string, curAmmo: number, preAmmo: number)=>{})	[纯客户端] 成功拿到枪后调用，可以在这里改UI、摄像机属性
onClientOneShootComplete((curAmmo: number, preAmmo: number))=>{})	[纯客户端] 每批次射击完成时调用，不管半自动还是全自动，也不管子弹数，打一次射线就会掉一次，可以在这里接UI更新子弹数
onClientReloadComplete((curAmmo:number, preAmmo:number))=>{})	[纯客户端] 每次成功换弹后调用，可以在这里接UI更新子弹数
onClientRemovedGun(()=>{})	[纯客户端] 成功下掉枪后调用，可以在这里改UI、摄像机属性
onClientHit((victim?: Player, damage?:number)=>{})	[纯客户端] 当客户端击中敌方时，可以在这里修改UI、播放集中音效、提示等，但此时并未造成伤害，伤害仅由服务端执行
ServerDamageChar((attacker: string, victim: string, damege: number, HeadShot?: boolean)=>{})	[纯服务器] 处理伤害
checkIfFriendly: ((PlayerID1: string, PlayerID2: string) => boolean)	[双端可用] 检查两个玩家id是否为友军