概述

阅读本文档,您可以了解如何使用Phaser运行库。该运行库使用JavaScript语言。我们将通过一个示例来说明如何加载导出的JSON文件并在场景中进行播放。请注意,该运行库需要一个支持WebGL的后台

获取运行库

您可以直接从Creature游戏运行库窗口下载运行库,或点击 这里从版本库获取运行库。

选择文件格式和运行库类型

有两种运行库类型可供选择:JSON/Creature平面数据CreaturePack Web格式

JSON/Creature平面数据:为您提供完整的骨骼结构,功能更丰富,但尺寸更大,如果不使用点缓存,评估成本将更高。

CreaturePack Web格式:只提供变形的点、贴图坐标和颜色。不提供角色的骨架结构。但该运行库更小,评估成本更低,因此播放非常快。

JSON/Creature平面数据

应含脚本

以下是需要包含的脚本:

    <script src="phaser.js"></script>
    <script src="https://raw.githubusercontent.com/toji/gl-matrix/master/dist/gl-matrix.js"></script>
	<script src="CreatureMeshBone.js"></script>
	<script src="CreaturePixiJSRenderer.js"></script>
	<script src="CreaturePhaserRenderer.js"></script>

加载和初始化

假设已导出一个名为dragonTest.json的龙动画文件,及其相应的纹理图谱character-dragon.png

首先加载文件资源:

    function preload () {
        game.load.text('dragonJSON', 'dragonTest.json');
         
        // 从图像路径创建纹理
		texture = PIXI.Texture.fromImage("character-dragon.png");
		
    }
		
		...

上述操作将从磁盘加载JSON数据并进入内存。然后,创建可以使用这些加载的资源的实际对象:

		var actual_JSON = JSON.parse(game.cache.getText('dragonJSON'));
		
		new_creature = new Creature(actual_JSON, false);
		
		new_animation_1 = new CreatureAnimation(actual_JSON, "default", false);
		new_animation_2 = new CreatureAnimation(actual_JSON, "pose2", false);
		
		new_manager = new CreatureManager(new_creature);
		new_manager.AddAnimation(new_animation_1);
		new_manager.AddAnimation(new_animation_2);

在上述示例中,JSON文件有2个动画剪辑:默认剪辑和第二剪辑。因此,您需要从Creature管理器对象创建2个动画,使它们可以播放。

已完成加载,可以将活动动画设置为默认,并设置一些播放属性,以用于播放:

		new_manager.SetActiveAnimationName("pose2", false);
		new_manager.SetShouldLoop(true);
		new_manager.SetIsPlaying(true);
		new_manager.RunAtTime(0);

现在继续创建对象来渲染角色动画:

		creaturePhaserObject = new Phaser.CreatureDraw(game.world, 
											game.world.centerX, 
											game.world.centerY,
											new_manager,
											texture);
											
		creaturePhaserObject.scale.set(35.0);
		game.world.add(creaturePhaserObject);

角色动画播放速度

您非常容易即可更改播放速度。您只需要为您的Phaser Creature对象的时间增量属性设置一个新值:

		creaturePhaserObject.timeDelta = 0.01; // 或其它值

完整代码示例

以下为完整的代码布局。大多数代码是从默认的Phaser项目启动器模板生成的。

	<!doctype html>
	<html>
	  <head>
    <meta charset="UTF-8" />
    <title>hello phaser!</title>
    <script src="phaser.js"></script>
    <script src="https://raw.githubusercontent.com/toji/gl-matrix/master/dist/gl-matrix.js"></script>
	<script src="CreatureMeshBone.js"></script>
	<script src="CreaturePixiJSRenderer.js"></script>
	<script src="CreaturePhasePhaserrRenderer.js"></script>
</head>
<body>

<script type="text/javascript">

window.onload = function() {

    var game = new Phaser.Game(800, 600, Phaser.WEBGL, '', { preload: preload, create: create });
    var texture = null;
    var new_creature = null;
    var new_animation_1 = null;
    var new_animation_2 = null;
    var new_manager = null;
    var creaturePhaserObject = null;

    function preload () {
        game.load.text('dragonJSON', 'dragonTest.json');
         
        // 从图像路径创建纹理
		texture = PIXI.Texture.fromImage("character-dragon.png");
		
    }

    function create () {
        // 核心 Creature 对象
		var actual_JSON = JSON.parse(game.cache.getText('dragonJSON'));
		
		new_creature = new Creature(actual_JSON, false);
		
		new_animation_1 = new CreatureAnimation(actual_JSON, "default", false);
		new_animation_2 = new CreatureAnimation(actual_JSON, "pose2", false);
		
		new_manager = new CreatureManager(new_creature);
		new_manager.AddAnimation(new_animation_1);
		new_manager.AddAnimation(new_animation_2);
		new_manager.SetActiveAnimationName("pose2", false);
		new_manager.SetShouldLoop(true);
		new_manager.SetIsPlaying(true);
		new_manager.RunAtTime(0);
		
		console.log('Loaded and created Core Creature Objects.');
		
		// Phaser Creature对象
		creaturePhaserObject = new Phaser.CreatureDraw(game.world, 
												game.world.centerX, 
												game.world.centerY,
												new_manager,
												texture);
		creaturePhaserObject.scale.set(35.0);
		game.world.add(creaturePhaserObject);
		
					
    }

};

</script>

 </body>
</html>

自定义时间/帧范围

您可以为当前活动的动画设置自定义时间/帧范围。假设您想将播放限制在10到20的帧范围内,您可以执行以下操作:

new_creature_manager.SetUseCustomTimeRane(true);
new_creature_manager.SetCustomTimeRange(10, 20);

动画混合

您可以执行以下操作来混合2个动画剪辑:

curManager.SetBlending(true);	
curManager.SetBlendingAnimations("default", "pose2");
curManager.SetBlendingFactor(0.5);	 // 在混合时,可选数值为从0到1

使用Creature平面二进制数据缩减加载时间及内存用量

您可以通过将Creature JSON文件转换为Creature平面二进制数格式来缩减大角色资源的加载时间及内存用量。设备上的堆内存不足时,我们建议您使用平面二进制数据格式加载Creature角色资源。

首先,进入 Creature工具Github页面

  1. 进入平面数据目录;

2)您可以编译Creature平面数据转换器程序,或者从Bin目录中获取系统(Mac或Windows)的二进制数据。

运行Creature平面数据转换器

Creature平面数据转换器是一个命令行程序,可以使用置入的导出Creature角色的JSON文件并将其转换为二进制Creature平面数据文件。建议为最终转换输出的二进制文件使用**.bytes**扩展名,以便Unity可以将其识别为二进制资源。

要运行Creature平面数据转换器,请加载以下终端或命令提示符:

CreatureFlatData <Input JSON File> <Output .bytes File>

使用Creature平面二进制文件

首先,在当前框架中检索二进制文件。 然后,执行以下操作:

		var actual_data = CreatureModuleUtils.LoadCreatureFlatData(game.cache.getBinary('myFlatDataBinary.bin'));
		
		new_creature = new Creature(actual_data, true);			
		new_animation_1 = new CreatureAnimation(actual_data, "idle", true);

通过上述操作可以看出,您需要做的只是获取对平面数据对象的引用。然后将CreatureCreature动画创建中的最后一个参数设置为true。即可触发二进制平面数据加载。

CreaturePack Web格式

调整CreaturePack Web格式

在Creature的游戏引擎导出窗口中,您可以看到以下选项:

间隙步长:该选项确定在导出时执行多少近似化。该数字越大,文件大小越小,但质量越差。值为1时表示无近似。建议范围:1到6;

UV交换:打开或关闭该选项,以确定是否导出UV交换。如需使用图像交换,您应将该选项选择为ON;

颜色更改:打开或关闭该选项,以确定是否导出任何不透明度更改。如需使用淡出区域,您应将该选项选择为ON。

通过增加间隙步长可以缩减相当多的文件大小,但会造成一些质量损失。

应含脚本

以下是需要包含的脚本:

	<script src="msgpack.js"></script>
	<script src="CreaturePackModule.js"></script>
	<script src="CreaturePixiPackJSRenderer.js"></script>
	<script src="CreaturePhaserPackRenderer.js"></script>
	

加载和初始化

获取您的文件的二进制缓冲区并将其传递到CreaturePack加载器:

		creature_pack = new CreaturePackLoader(game.cache.getBinary('raptorPack').buffer);
		

渲染

创建CreaturePackDraw对象并将其添加到场景中:

		creature_pack = new CreaturePackLoader(game.cache.getBinary('raptorPack').buffer);
		console.log('Loaded and created Core Creature Objects.');				

		var creature_renderer = new Phaser.CreaturePackDraw(game.world, 
												game.world.centerX, 
												game.world.centerY,
												creature_pack,
												texture);
											
		creature_renderer.pack_renderer.setActiveAnimation("default");													
		creature_renderer.scale.set(15.0);
		creature_renderer.timeDelta = 1;
		game.world.add(creature_renderer);