类阴阳师血条UI的实现总结

RPG游戏中,角色头部上方的血条UI是非常常见的。 f:id:lvmingbei:20170321162921p:plain 例如阴阳师的血条如上图所示。 无论如何变换视角,血条都是固定在角色头部上方。 f:id:lvmingbei:20170321162927p:plain 直觉上是觉得血条是绑在与角色的3D模型上的。但是如果实际把血条放入到3D世界中,那么会存在如下几个问题。

  1. 旋转视角过程中血条的朝向问题。
  2. 血条的渲染顺序问题
  3. 血条的透视显示问题

f:id:lvmingbei:20170321164815p:plain

问题1的解决办法: 可以通过在血条上面挂载Script,在Update方法中使血条始终LookForward我们的MainCamera。

问题2的解决办法: 通过设置SortingLayer,使血条的渲染顺序永远在3D模型后面。

问题3在固定视角的游戏中是比较容易解决的,在类似阴阳师这种能够随便旋转视角的游戏中,解决起来比较麻烦。

不妨换一个思路来实现,把血条UI从3D世界中拿回到普通UI层来实现。 把血条挪到UI层来实现,需要解决的唯一问题就是,正确的计算角色的WorldPositon在2D UI平面上的位置,并把血条显示在正确的坐标。

f:id:lvmingbei:20170321165124p:plain

代码如上,即可以计算出正确显示血条UI的座标。其中的offset是血条相对于角色的偏移量。

f:id:lvmingbei:20170321165853p:plain

AssetBundle Load模拟器的实现

问题

游戏开发在进入一定阶段后,必定会导入AssetBundle系统。

修改了AssetBundle的数据后,想看到变化后的内容,开发的流程如下图:
f:id:lvmingbei:20160830161052p:plain

每一次修改Asset之后,都需要重新对AssetBundle进行编译,非常浪费时间。 所以这次想要做一个AssetBundle Load的模拟器。

在使用模拟器后,开发的流程可以变成下图:
f:id:lvmingbei:20160830161050p:plain

其实AssetBundleManager中含有一个类似的功能叫SimulationMode,但是AssetBundleManager由于一些问题,我们没有使用,所以也需要自己实现这个功能。

AssetBundle Load模拟器

功能简介

  1. Asset更新时无需Build AssetBundle即可读取Asset
  2. 可以立即反应出更新后的内容
  3. 支持Variant
  4. 能够简单的在模拟器模式和普通模式间切换5.

实现方法

模拟器主要需要对两种资源的加载进行模拟,一种是Scene,另一种是普通的Asset。
可以使用如下方法,根据AssetBundle名和Asset名来取得本地的文件路径。
AssetDatabase.GetAssetPathsFromAssetBundleAndAssetName(assetBundleName, assetName);

Load Scene

我们知道,在AssetBundle中的Scene是不需要添加入BuildSettings也可以使用SceneManager来进行Load的。
那么在Editor中,我们可以使用如下API来完成同样的功能。无需添加BuildSetting对Scene进行Load。

具体实现如下
f:id:lvmingbei:20160830161057p:plain

Load Asset

读取普通的Asset可以使用以下API
public static Object LoadMainAssetAtPath(string assetPath);

具体实现如下

f:id:lvmingbei:20160830161055p:plain

模拟器中Variant的实现

AssetBundleManager中,实现Variant的方法是通过m_AssetBundleManifest.GetAllAssetBundlesWithVariant()方法来取得所有含有Variant的AssetBundle。 然后去匹配ActiveVariants来决定使用哪个Variant。
在Editor中我们可以使用AssetDatabase.GetAllAssetBundleNames()方法取得所有的AssetBundle,然后过滤出含有Variant的AssetBundle。含有Varinat的AssetBundle的名字是name.variant的形式。
后面的处理就可以沿用AssetBundleManager的了。

Unity的资源下载与缓存系统的实现

在Unity开发的游戏中,我们经常会下载,缓存,更新资源文件,达到更新游戏内容的目的。(主要是AssetBundle文件)

Unity中已经提供了简单的下载与缓存功能,WWW.LoadFromCacheOrDownload可以满足基本的文件下载和缓存的需求。

为什么要自己重新造轮子

为什么还要自己重新设计实现这个下载缓存系统呢。

对我们的项目来说,WWW.LoadFromCacheOrDownload有几个比较重大的缺点:

  1. 无法取得下载的资源文件的路径,导致无法实现对文件的管理。

  2. 在使用WWW.LoadFromCacheOrDownload前,需要等待Caching.ready,随着缓存文件的增加,Caching.ready的速度会越来越慢。

  3. WWW不支持断点续传。断点续传需要设置HTTP Header,但是WWW会把设置了Header的Request全部作为POST来处理。 我们的游戏需要应对各种复杂的网络环境,在网络很差的环境下,一旦文件下载失败就从头开始下载是不可接受的。

  4. WWW可设置的参数非常少,例如Timeout不可设置。

HTTP Client的选择

我们对比了几种Client,总结如下表。

Libray 来源 优点 缺点
WWW Unity内置 可以使用Unity自带Cache功能;不会增加build的size 设置Header会导致Request变成POST,因此无法用于CDN下载;无法设置Timeout,Redirect次数等参数
UnityWebRequest Unity内置 不会增加build的size 无法使用Unity的cache,需要自己实现cache;Timeout无法设置,无法使用HTTPS的证书;还处于Experimental中,经常会导致程序崩溃
BestHTTP 第三方Asset 可以断点续传;文档非常丰富;Redirect,Timeout等参数可以设置;可以使用HTTPS的self-signed certificate 会增加数MB的build size;需要自己实现cache system
HttpWebRequest .NET / Mono System.Net namespace,可以减少build size 无法在Coroutines中使用

最终我们选择了BestHTTP,这是一个付费的Asset,价格55美元。好在并不需要每人一个license。给官方发邮件确认后,得知一个团队(公司)只需要购买一个license就可以了。

缓存系统的设计与实现

由于不使用WWW.LoadFromCacheOrDownload,所以需要自己实现缓存系统。
基本的需求是,游戏逻辑向缓存系统请求一个资源文件list:

  1. 当服务器的文件本地不存在时,下载并缓存。
  2. 当服务器的文件版本与本地不一致时,下载更新,替换本地文件
  3. 服务文件与本地文件一致,不下载,直接使用本地的缓存文件
  4. 检查下载文件完整性

源文件版本控制

AssetBundle的依赖关系我们可以从Single Manifest文件中取得。Single Manifest还包含了每个AssetBundle文件的Hash值,用 AssetBundleManifest.GetAssetBundleHash方法可以取得该HASH值。可以用于确认本地文件和服务器文件的版本是否一致。
本想直接利用这个Hash值进行文件完整性验证,但是这个Hash的算法既不是MD5也不是SHA1,自己无法计算,所以就放弃了这个想法。
我们在AssetBundle build的同时,生成一个ResourceList的文本文件,里面记录文件的CRC和size。格式如下:

filename|CRC|size

加入文件大小的原因是,想要在下载的界面上显示剩余下载的大小,而SingleManifest文件中并没有提供文件的大小。 在每次下载前,先需要下载SingleManifest文件和ResourceList文件,然后再判定哪些文件需要下载,哪些文件从缓存中读取。
f:id:lvmingbei:20160427163004p:plain

文件下载分为,新文件下载,文件更新下载,断点续传下载,从本地读取几种情况。判定方法如下图。
f:id:lvmingbei:20160427165724p:plain

下载的文件都存储于Application.persistentDataPath中,该目录不会被系统清理缓存等操作被清空。但是注意Android手机如果SD卡被拔出,可能会造成之前写入的文件无法访问。

下载断点续传的实现

根据HTTP协议,在HTTP Request的Header中加入Range: bytes=start-end(单位是字节),就可以从上次中断的位置继续下载。
本地写入文件时,选择Append模式即可。

保持下载不中断

当下载文件较大时,下载可能会消耗比较长的时间。如果用户把手机放在一旁,手机自动进入休眠导致下载中断,或者切换到别的程序,而导致下载中断,会导致比较差的游戏体验。所以这个方面也要进行处理。

让设备不进入休眠

Screen.sleepTimeout = SleepTimeout.NeverSleep;   

我们可以使用这个API来设置,在下载期间不让机器进入休眠状态。当下载结束后,再将这个设置恢复成默认。

当程序切换

Application.runInBackground = true;

使用这个API可以让程序切换到后台的时候仍然保持下载继续。同样不要忘记在下载结束后,把设置恢复。

网络连接情况的监测

当设备进行网络切换的时候,例如,从蜂窝移动网络切换到Wifi,从Wifi A切换到Wifi B,这种情况下,原本的连接一定会超时失败,但是我们不想等待超时,当网络连接发生变化时候,主动放弃连接,并进行Retry,以提高下载效率。
通过Unity中Application.internetReachability可以获取到当前网络状态,我们可以将其保存下来,然后在Update方法中进行检测,就可以得知网络是否发生了变化。

void Update ()
{
    if (Application.internetReachability != m_reachability) {
        m_request.Abort ();
    }
    m_reachability = Application.internetReachability;
}
    

Unity UI(uGUI) 源码学习笔记(一) Button

Unity在4.6版本推出了自己的UI系统,虽然目前功能相比NGUI等成熟的Asset还比较少,但是使用它来开发游戏项目还是完全没有问题的。
而且Unity官方开源了UI系统的C#源代码,我们也可以学习一下Unity是如何实现这套UI系统的。

源代码下载

https://bitbucket.org/Unity-Technologies/ui
Unity是把代码放在了Bitbucket上面,通过SourceTree等客户端软件,就可以克隆整个项目到本地。
克隆到本地之后,可以是用Visual Studio或者MonoDevelop对源代码进行修改和编译。

从Button开始学习

首先从一个最简单的Button开始学习UI系统的源代码。
通过Button的源代码,再逐步去学习关联的源代码。

Button源代码

Button的Class位于UnityEngine.UI的package中,我们可以看到UISystem是有二个package的,UnityEngine是核心Class的实现,UnityEditor是对Editor的扩展,方便大家使用。
f:id:lvmingbei:20150512141848p:plain

通过上面的源代码我们可以看到,当前这个版本的Button Class只有74行代码,很适合用来入门用。

类的定义

public class Button : Selectable, IPointerClickHandler, ISubmitHandler

首先我们看Button类的定义,Button继承自Selectable,并且实现了两个接口IPointerClickHandlerISubmitHandler
通过Unity的文档我们可以得知,Selectable类是一种可以被选择的组件的基类,两个接口分别是接受OnPointerClick和OnSubmit两个CallBack方法。 以后再学习Selectable类的源代码,先继续向后读Button的代码。

// Event delegates triggered on click.
[FormerlySerializedAs("onClick")]
[SerializeField]
private ButtonClickedEvewnt m_OnClick = new ButtonClickedEvent();

这里定义了一个叫m_OnClick的变量,类型为ButtonClickedEvent。看命名应该是用来设置Button点击时候的事件。
ButtonClickedEvent是继承自UnityEvent的空Class。

我们继续往后看,后面是两个接口定义的CallBack方法的实现。

// Trigger all registered callbacks.
public virtual void OnPointerClick(PointerEventData eventData)
{
    if (eventData.button != PointerEventData.InputButton.Left)
        return;

    Press();
}

public virtual void OnSubmit(BaseEventData eventData)
{
    Press();

    // if we get set disabled during the press
    // don't run the coroutine.
    if (!IsActive() || !IsInteractable())
        return;

    DoStateTransition(SelectionState.Pressed, false);
    StartCoroutine(OnFinishSubmit());
}

OnPointerClick方法是当点击Button时调用,首先判断是否为左键,如果是左键,就立即调用私有的Press方法。
Press方法是Invoke所有注册的onClick的CallBack方法。 OnSubmit方法是当提交的时候调用。 首先通过继承的DoStateTransition方法,显示Pressed状态的动画或者Fade效果,然后使用Coroutine等待Fade结束,再次调用DoStateTransition进行Button的状态迁移。

Button的源代码就简单分析到这里,再向下分析涉及到许多更底层的实现,后续会继续分析关联到的其他Class的代码。 包括一些Selectable(可选择组件基类),EventSystems(事件系统),InputModule(输入模块)等等。

Unity Attribute 总结

Attribute是C#功能,在Unity中可以使用Attribute来给变量和方法增加新的属性或者功能

举两个例子,在变量上使用[SerializeFiled]属性,可以强制让变量进行序列化,可以在Unity的Editor上进行赋值。
在Class上使用[RequireComponent]属性,就会在Class的GameObject上自动追加所需的Component。

以下是Unity官网文档中找到的所有Attribute,下面将按照顺序,逐个对这些Attribute进行说明和小的测试。
部分例子使用了Unity官方的示例。

UnityEngine

AddComponentMenu

可以在UnityEditor的Component的Menu中增加自定义的项目。菜单可以设置多级,使用斜线/分隔即可。在Hierarchy中选中GameObject的时候,点击该菜单项,就可以在GameObject上追加该Component。
例如如下代码可以完成下图的效果。

[AddComponentMenu("TestMenu/TestComponet")]
public class TestMenu : MonoBehaviour {
}

f:id:lvmingbei:20150406160818p:plain

AssemblyIsEditorAssembly

汇编级属性,使用该属性的Class会被认为是EditorClass。具体用法不明。

ContextMenu

可以在Inspector的ContextMenu中增加选项。
例如,如下代码的效果

public class TestMenu : MonoBehaviour {
    [ContextMenu ("Do Something")]
    void DoSomething () {
        Debug.Log ("Perform operation");
    }
}

f:id:lvmingbei:20150406162538p:plain

ContextMenuItemAttribute

这个属性是Unity4.5之后提供的新功能,可以在Inspector上面对变量追加一个右键菜单,并执行指定的函数
例子:

public class Sample : MonoBehaviour {
    [ContextMenuItem("Reset", "ResetName")]
    public string name = "Default";
    void ResetName() {
        name = "Default";
    }
}

f:id:lvmingbei:20150406164234g:plain

DisallowMultipleComponent

对一个MonoBehaviour的子类使用这个属性,那么在同一个GameObject上面,最多只能添加一个该Class的实例。
尝试添加多个的时候,会出现下面的提示。
f:id:lvmingbei:20150406165035p:plain

ExecuteInEditMode

默认状态下,MonoBehavior中的Start,Update,OnGUI等方法,需要在Play的状态下才会被执行。
这个属性让Class在Editor模式(非Play模式)下也能执行。
但是与Play模式也有一些区别。
例如:
Update方法只在Scene编辑器中有物体产生变化时,才会被调用。
OnGUI方法只在GameView接收到事件时,才会被调用。

HeaderAttribute

这个属性可以在Inspector中变量的上面增加Header。
例子:

public class ExampleClass : MonoBehaviour {
    [Header("生命值")]
    public int CurrentHP = 0;
    public int MaxHP = 100;

    [Header("魔法值")]
    public int CurrentMP = 0;
    public int MaxMP = 0;
}

f:id:lvmingbei:20150406171544p:plain

HideInInspector

在变量上使用这个属性,可以让public的变量在Inspector上隐藏,也就是无法在Editor中进行编辑。

ImageEffectOpaque

在OnRenderImage上使用,可以让渲染顺序在非透明物体之后,透明物体之前。
例子

[ImageEffectOpaque]
void OnRenderImage (RenderTexture source, RenderTexture destination){
}
ImageEffectTransformsToLDR

渲染从从HDR变为LDR 具体使用方法不明。

MultilineAttribute

在string类型上使用,可以在Editor上输入多行文字。

public class TestString : MonoBehaviour {
    [MultilineAttribute]
    public string mText;
}

f:id:lvmingbei:20150406183813p:plain

NotConvertedAttribute

在变量上使用,可以指定该变量在build的时候,不要转换为目标平台的类型。

NotFlashValidatedAttribute

在变量上使用,在Flash平台build的时候,对该变量不进行类型检查。
Unity5.0中已经移除了这个属性。

NotRenamedAttribute

禁止对变量和方法进行重命名。
Unity5.0中已经移除了这个属性。

PropertyAttribute
RangeAttribute

在int或者float类型上使用,限制输入值的范围

public class TestRange : MonoBehaviour
{
    [Range(0, 100)] public int HP;
}
RequireComponent

在Class上使用,添加对另一个Component的依赖。
当该Class被添加到一个GameObject上的时候,如果这个GameObject不含有依赖的Component,会自动添加该Component。
且该Componet不可被移除。

例子

[RequireComponent(typeof(Rigidbody))]
public class TestRequireComponet : MonoBehaviour {

}

f:id:lvmingbei:20150406191049g:plain
如果尝试移除被依赖的Component,会有如下提示
f:id:lvmingbei:20150406191137p:plain

RPC

在方法上添加该属性,可以网络通信中对该方法进行RPC调用。

[RPC]
void RemoteMethod(){
}
RuntimeInitializeOnLoadMethodAttribute

此属性仅在Unity5上可用。
在游戏启动时,会自动调用添加了该属性的方法。

class MyClass
{
    [RuntimeInitializeOnLoadMethod]
    static void OnRuntimeMethodLoad ()
    {
        Debug.Log("Game loaded and is running");
    }
}
SelectionBaseAttribute

当一个GameObject含有使用了该属性的Component的时候,在SceneView中选择该GameObject,Hierarchy上面会自动选中该GameObject的Parent。

SerializeField

在变量上使用该属性,可以强制该变量进行序列化。即可以在Editor上对变量的值进行编辑,即使变量是private的也可以。
在UI开发中经常可见到对private的组件进行强制序列化的用法。
例子

public class TestSerializeField : MonoBehaviour {
    [SerializeField]
    private string name;

    [SerializeField]
    private Button _button;
}

f:id:lvmingbei:20150406194030p:plain

SharedBetweenAnimatorsAttribute

用于StateMachineBehaviour上,不同的Animator将共享这一个StateMachineBehaviour的实例,可以减少内存占用。

SpaceAttribute

使用该属性可以在Inspector上增加一些空位。 例子:

public class TestSpaceAttributeByLvmingbei : MonoBehaviour {
    public int nospace1 = 0;
    public int nospace2 = 0;
    [Space(10)]
    public int space = 0;
    public int nospace3 = 0;
}

f:id:lvmingbei:20150407121446p:plain

TextAreaAttribute

该属性可以把string在Inspector上的编辑区变成一个TextArea。
例子:

public class TestTextAreaAttributeByLvmingbei : MonoBehaviour {
    [TextArea]
    public string mText;
}

f:id:lvmingbei:20150407121811p:plain

TooltipAttribute

这个属性可以为变量上生成一条tip,当鼠标指针移动到Inspector上时候显示。

public class TestTooltipAttributeByLvmingbei : MonoBehaviour {
    [Tooltip("This year is 2015!")]
    public int year = 0;
}

f:id:lvmingbei:20150407122412p:plain

UnityAPICompatibilityVersionAttribute

用来声明API的版本兼容性

UnityEngine.Serialization

FormerlySerializedAsAttribute

该属性可以令变量以另外的名称进行序列化,并且在变量自身修改名称的时候,不会丢失之前的序列化的值。
例子:

using UnityEngine;
using UnityEngine.Serialization;
public class MyClass : MonoBehaviour {
    [FormerlySerializedAs("myValue")]
    private string m_MyValue;
    public string myValue
    {
        get { return m_MyValue; }
        set { m_MyValue = value; }
    }
}

UnityEngine.Editor

该package为Editor开发专用

CallbackOrderAttribute

定义Callback的顺序

CanEditMultipleObjects

Editor同时编辑多个Component的功能

CustomEditor

声明一个Class为自定义Editor的Class

CustomPreviewAttribute

将一个class标记为指定类型的自定义预览
Unity4.5以后提供的新功能
例子:

[CustomPreview(typeof(GameObject))]
public class MyPreview : ObjectPreview
{
    public override bool HasPreviewGUI()
    {
        return true;
    }

    public override void OnPreviewGUI(Rect r, GUIStyle background)
    {
        GUI.Label(r, target.name + " is being previewed");
    }
}
CustomPropertyDrawer

标记自定义PropertyDrawer时候使用。
当自己创建一个PropertyDrawer或者DecoratorDrawer的时候,使用该属性来标记。 TODO: 如何创建属于自己的Attribute

DrawGizmo

可以在Scene视图中显示自定义的Gizmo
下面的例子,是在Scene视图中,当挂有MyScript的GameObject被选中,且距离相机距离超过10的时候,便显示自定义的Gizmo
Gizmo的图片需要放入Assets/Gizmo目录中。
例子:

using UnityEngine;
using UnityEditor;

public class MyScript : MonoBehaviour {
    
}

public class MyScriptGizmoDrawer {
    
    [DrawGizmo (GizmoType.Selected | GizmoType.Active)]
    static void DrawGizmoForMyScript (MyScript scr, GizmoType gizmoType) {
        Vector3 position = scr.transform.position;
        
        if(Vector3.Distance(position, Camera.current.transform.position) > 10f)
            Gizmos.DrawIcon (position, "300px-Gizmo.png");
    }
    
}

f:id:lvmingbei:20150410162651p:plain

InitializeOnLoadAttribute

在Class上使用,可以在Unity启动的时候,运行Editor脚本。
需要该Class拥有静态的构造函数
做一个创建一个空的gameobject的例子。
例子:

using UnityEditor;
using UnityEngine;

[InitializeOnLoad]
class MyClass
{
    static MyClass ()
    {
        EditorApplication.update += Update;
        Debug.Log("Up and running");
    }
    
    static void Update ()
    {
        Debug.Log("Updating");
    }
}
InitializeOnLoadMethodAttribute

在Method上使用,是InitializeOnLoad的Method版本。
Method必须是static的。

MenuItem

在方法上使用,可以在Editor中创建一个菜单项,点击后执行该方法,可以利用该属性做很多扩展功能。 需要方法为static。
例子:

using UnityEngine;
using UnityEditor;
using System.Collections;

public class TestMenuItem : MonoBehaviour {

    [MenuItem ("MyMenu/Create GameObject")]
    public static void CreateGameObject() {
        new GameObject("lvmingbei's GameObject");
    }
}

f:id:lvmingbei:20150412204353g:plain

PreferenceItem

使用该属性可以定制Unity的Preference界面。
在这里就使用官方的例子:

using UnityEngine;
using UnityEditor;
using System.Collections;

public class OurPreferences {
    // Have we loaded the prefs yet
    private static bool prefsLoaded = false;
    
    // The Preferences
    public static bool boolPreference = false;
    
    // Add preferences section named "My Preferences" to the Preferences Window
    [PreferenceItem ("My Preferences")]
    public static void PreferencesGUI () {
        // Load the preferences
        if (!prefsLoaded) {
            boolPreference = EditorPrefs.GetBool ("BoolPreferenceKey", false);
            prefsLoaded = true;
        }
        
        // Preferences GUI
        boolPreference = EditorGUILayout.Toggle ("Bool Preference", boolPreference);
        
        // Save the preferences
        if (GUI.changed)
            EditorPrefs.SetBool ("BoolPreferenceKey", boolPreference);
    }
}

f:id:lvmingbei:20150412210832p:plain

UnityEditor.Callbacks

这个package中是三个Callback的属性,都需要方法为static的。

OnOpenAssetAttribute

在打开一个Asset后被调用。
例子:

using UnityEngine;
using UnityEditor;
using UnityEditor.Callbacks;
    
public class MyAssetHandler {

    [OnOpenAssetAttribute(1)]
    public static bool step1(int instanceID, int line) {
        string name = EditorUtility.InstanceIDToObject(instanceID).name;
        Debug.Log("Open Asset step: 1 ("+name+")");
        return false; // we did not handle the open
    }

    // step2 has an attribute with index 2, so will be called after step1
    [OnOpenAssetAttribute(2)]
    public static bool step2(int instanceID, int line) {
        Debug.Log("Open Asset step: 2 ("+instanceID+")");
        return false; // we did not handle the open
    }
}
PostProcessBuildAttribute

该属性是在build完成后,被调用的callback。
同时具有多个的时候,可以指定先后顺序。
例子:

using UnityEngine;
using UnityEditor;
using UnityEditor.Callbacks;
    
public class MyBuildPostprocessor {
    [PostProcessBuildAttribute(1)]
    public static void OnPostprocessBuild(BuildTarget target, string pathToBuiltProject) {
        Debug.Log( pathToBuiltProject );
        }
}
PostProcessSceneAttribute

使用该属性的函数,在scene被build之前,会被调用。
具体使用方法和PostProcessBuildAttribute类似。

参考资料

UnityのAttribute(属性)についてまとめてメモる。 - テラシュールブログ

AttributeUsage (C# および Visual Basic)