月度归档:2015年05月

如何在Unity3D Editor脚本中使用Coroutine进行异步操作

今天在做编辑器中一个功能时,碰到一个这样的需求,Unity3D Editor脚本中会通过System.Diagnostics.Process这个类来调用外部的系统命令来执行一个操作,其实就是调用系统的Python命令执行一个Python脚本,来将Excel文件转换成文本数据。

[MenuItem ("LightHonor/Config/ImportExcel")]
static void ConvertXlsxToTxtConfig ()
{
    string txt2xlsxPythonFilePath = Directory.GetParent (Application.dataPath) 
        + Path.DirectorySeparatorChar.ToString () + "Docs" 
        + Path.DirectorySeparatorChar.ToString () + "Tools" 
        + Path.DirectorySeparatorChar.ToString () + "convert.py";
    if (Application.platform == RuntimePlatform.OSXEditor) {
        System.Diagnostics.ProcessStartInfo startInfo = new System.Diagnostics.ProcessStartInfo ("/usr/bin/python", txt2xlsxPythonFilePath);
        System.Diagnostics.Process convertProcess = new System.Diagnostics.Process ();
        convertProcess.StartInfo = startInfo;
        convertProcess.EnableRaisingEvents = true;
        convertProcess.Exited += new System.EventHandler (ConvertProcessExited);
        convertProcess.Start ();
    } else if (Application.platform == RuntimePlatform.WindowsEditor) {
        System.Diagnostics.ProcessStartInfo startInfo = new System.Diagnostics.ProcessStartInfo (@"C:\Python27\python.exe", txt2xlsxPythonFilePath);
        System.Diagnostics.Process convertProcess = new System.Diagnostics.Process ();
        convertProcess.StartInfo = startInfo;
        convertProcess.EnableRaisingEvents = true;
        convertProcess.Exited += new System.EventHandler (ConvertProcessExited);
        convertProcess.Start ();
    }
}

private static void ConvertProcessExited (object sender, System.EventArgs e)
{
    Debug.Log ("Convert Excel Xlsx Config To Text File Done!");
}

但是这样执行完ImportExcel菜单项之后,可能会出现我们通过外部的脚本修改了Unity3D需要使用到的文本文件,但是Unity3D未能及时更新AssetDatabase,导致Unity3D中读取到的文本文件还是执行ImportConfig菜单项之前的数据。那么我们能否直接在这个外部程序执行完毕的回调中执行AssetDatabase.Refresh()方法呢?不行,因为这些函数都只能在主线程里头调用,而这个回调函数是在启动外部程序的线程中执行的,所以在ConvertProcessExited()方法中访问AssetDatabase对象会抛出异常。这个时候我们可以通过EditorApplication的update委托来配合Coroutine机制来完成我们想要的功能。

关于EditorApplication如何支持Coroutine,这个是在GitHub上找到了一个很棒的参考,地址在这儿,链接页面中是一个完整的独立的EditorCoroutine的实现,借助于这个漂亮的工具,我们修改了代码,然后就能达成我们的需求了,在执行完外部转化的Python程序之后,及时通过AssetDatabase刷新Unity3D中需要使用到的文本文件,代码如下:

private static bool sConvertDone = false;

[MenuItem ("LightHonor/Config/ImportExcel")]
static void ConvertXlsxToTxtConfig ()
{
    string txt2xlsxPythonFilePath = Directory.GetParent (Application.dataPath) 
        + Path.DirectorySeparatorChar.ToString () + "Docs" 
        + Path.DirectorySeparatorChar.ToString () + "Tools" 
        + Path.DirectorySeparatorChar.ToString () + "convert.py";
    if (Application.platform == RuntimePlatform.OSXEditor) {
        System.Diagnostics.ProcessStartInfo startInfo = new System.Diagnostics.ProcessStartInfo ("/usr/bin/python", txt2xlsxPythonFilePath);
        System.Diagnostics.Process convertProcess = new System.Diagnostics.Process ();
        convertProcess.StartInfo = startInfo;
        convertProcess.EnableRaisingEvents = true;
        convertProcess.Exited += new System.EventHandler (ConvertProcessExited);
        convertProcess.Start ();
    } else if (Application.platform == RuntimePlatform.WindowsEditor) {
        System.Diagnostics.ProcessStartInfo startInfo = new System.Diagnostics.ProcessStartInfo (@"C:\Python27\python.exe", txt2xlsxPythonFilePath);
        System.Diagnostics.Process convertProcess = new System.Diagnostics.Process ();
        convertProcess.StartInfo = startInfo;
        convertProcess.EnableRaisingEvents = true;
        convertProcess.Exited += new System.EventHandler (ConvertProcessExited);
        convertProcess.Start ();
    }
    sConvertDone = false;
    EditorCoroutine.Start (RefreshAssetDatabase ());
}

static IEnumerator RefreshAssetDatabase ()
{
    while (!sConvertDone) {
        yield return 0;
    }
    AssetDatabase.Refresh ();
    Debug.Log ("Refresh Asset Database Done");
}

private static void ConvertProcessExited (object sender, System.EventArgs e)
{
    Debug.Log ("Convert Excel Xlsx Config To Text File Done!");
    sConvertDone = true;
}

 

AnimatorStateInfo中nameHash值

AnimatorStateInfo.IsName(sting name)这个方法是用来判断当前Animator播放的否是某个动画,而这个方法不只是比对动画名称的nameHash值,通过测试我们会发现传入纯粹的动画状态名称或者传入状态所在层名称和状态名称的组合,都是可以成功匹配的。

AnimatorStateInfo.IsName(string name)方法不仅会比对这个FullPath Name,还会比对Simple Name,例如我们在Base Layer中有一个名为Idle的状态。

那么通过AnimatorStateInfo.IsName(“Idle”)和AnimatorStateInfo.IsName(“Base Layer.Idle”)都是True,但是如果我们要直接比对nameHash的值,那就必须使用Animator.StringToHash(“Base Layer.Idle”) 和AnimatorStateInfo的nameHash属性值进行比对,而不能使用简称的nameHash值Animator.StringToHash(“Idle”)来进行比对。

在Unity4.6中AnimatorStateInfo中得nameHash属性值是通过Animator.StringToHash(“Base Layer.StateName”)获得的,参数是全路径名,全路径由状态所在层名称和动画状态名称组成,格式为“[LayerName].[StateName]”,请自行使用对应的LayerName和StateName替换方括号中的内容。


升级到Unity5之后,AnimatorStateInfo中就木有nameHash这个属性了,不过新增了两个字面意思更明确的属性,shortNameHash和fullPathName,两者的区别就是fullPathHash传入的Name参数是带上State所在的Layer的名字的,例如:Base Layer.Idle,而shortNameHash就是不带Layer名字的,例如:Idle。这样更明确了显然是更好的,看到Unity3D的文档一天天往完善了发展,还是深感幸福啊。

用Python写一个简单的Alfred Workflow用于颜色值的转换

由于自己是程序员,而且比较痴迷于使用各种工具,虽然可能这些工具并没有给我的效率带来太大的提高,但是我就是喜欢折腾这些软件,因为能给我带来快乐和满足感,你说谁不想爽呢。

Alfred是我使用Mac之后安装的第二个工具软件(正常工作需要的开发软件和浏览器之类的通用软件不算),第一个是Dash,第二个是Alfred。Dash是在试用了5分钟不到,查看Android帮助文档如飞的响应速度,让我直接购买了正版授权。Alfred是在当做Launch软件使用了快1年之后,看了很多人提到的关于Workflow的增强功能之后,在某个非常想购物的日子里头买了一个PowerPack,从此用上了Workflow的功能,当然在这一年里头实际上我也就只用了有道词典这么一个Workflow,其他的几乎不怎么使用,主要还是习惯问题。

这几天手痒,总觉得自己不像个能折腾的程序员,刚好看到一个用于转化数字的Workflow感觉还不错,试用了一下之后,我发现其实我自己也有一个比较强的需求可以通过这个Workflow来完成。在做Unity3D的开发过程中,我们时常会需要使用到调色板来给界面上的文字进行着色,就是设置颜色值。但是美术一般提供过来的就是效果图,或者是RGB值,通常格式是这样的(234,120,54),但是在实际的开发中我们并不是每次都是针对一个UILabel(我们的UI使用NGUI开发)进行字体颜色设置,因为有的时候我们只是想突出显示一段文字中的某一部分,这个时候依赖于NGUI UILabel的BBCode机制,我们可以通过 [ffbbcc]需要指定颜色显示的文字内容[-] 这样的方式来实现同一个UILabel下的文字使用不同的颜色进行显示。

那么这个时候有一个能快速转换(234,120,54)为#ea7836就有一些必要了,参考那个Number Convertor我就自己开始造轮子了。

Alfred Workflow设置页面

找到Number Convertor这个Workflow,选中任意一个Script Filter右键,弹出菜单之后点击Configure,或者直接双击也行,然后弹出一个配置页面,配置页面的右下方有一个Open workflow folder的按钮,点击之后会打开当前Workflow对应的所在目录,然后我们会发现这个目录下面有以下的内容:

Alfred Workflow对应目录

仔细查看一下,我们会发现所有的转化逻辑都是通过number_convertor.py文件来完成的,但是这个脚本依赖于一个叫Workflow的Python库,这个目录里头的workflow就是干这个用的。这个Python的库可以在这里找到。

以下是的脚本内容:

# -*- coding: utf-8 -*-
import sys
from workflow import Workflow

def main(wf):
    cmd = wf.args[0]
    input_str = wf.args[1]

    values_str = ""
    if cmd == "2rgb":
        values_str = conver_hex_to_rgb(input_str)
        desc = u'将%s转化为RGB格式' % (input_str)
    elif cmd == "2hex":
        values_str = convert_rgb_to_hex(input_str)
        desc = u'将%s转化为HEX格式' % (input_str)
    wf.add_item(title=values_str, subtitle=desc, arg=values_str, valid=True)
    wf.send_feedback()

def ignore_exception(IgnoreException=Exception,DefaultVal=None):
    """ Decorator for ignoring exception from a function
    e.g.   @ignore_exception(DivideByZero)
    e.g.2. ignore_exception(DivideByZero)(Divide)(2/0)
    """
    def dec(function):
        def _dec(*args, **kwargs):
            try:
                return function(*args, **kwargs)
            except IgnoreException:
                return DefaultVal
        return _dec
    return dec

sint = ignore_exception(ValueError,0)(int)


def convert_decimal_to_hex(numstr):
    decimal_var = sint(numstr)
    return "{0:#0{1}x}".format(decimal_var,4)[2:]

def convert_rgb_to_hex(rgb_str):
    if rgb_str.startswith("(") and rgb_str.endswith(")"):
        splits = rgb_str.strip("()").split(",")
        if (len(splits) == 3):
            red_decimal_str = splits[0]
            red_hex = convert_decimal_to_hex(red_decimal_str)
            green_decimal_str = splits[1]
            green_hex = convert_decimal_to_hex(green_decimal_str)
            blue_decimal_str = splits[2]
            blue_hex = convert_decimal_to_hex(blue_decimal_str)
            hex_str = "#" + red_hex + green_hex + blue_hex
            return hex_str
    	else:
    		return ""
    else:
        return ""

def conver_hex_to_rgb(hex_str):
	if hex_str.startswith("#"):
		hex_str = hex_str[1:]
        if len(hex_str) == 6:
            red_decimal_var = sint(hex_str[0:2],16)
            green_decimal_var = sint(hex_str[2:4],16)
            blue_decimal_var = sint(hex_str[4:6],16)
            return "(%d,%d,%d)" % (red_decimal_var, green_decimal_var, blue_decimal_var)
        elif len(hex_str) == 3:
            red_decimal_var = sint(hex_str[0:1] + hex_str[0:1],16)
            green_decimal_var = sint(hex_str[1:2] + hex_str[1:2],16)
            blue_decimal_var = sint(hex_str[2:3] + hex_str[2:3],16)
            return "(%d,%d,%d)" % (red_decimal_var, green_decimal_var, blue_decimal_var)
	else:
		return ""

if __name__ == u"__main__":
    wf = Workflow()
    sys.exit(wf.run(main))


然后我们就可以通过Workflow -> Add Templates -> Essentials -> Script Filter to Script创建一个Workflow,然后通过上面提到的方法进入设置页面打开Workflow所在目录,按照alfred-workflow的Python库的安装方式安装设置好alfred-workflow,然后将写好的Python脚本放到相应的位置,最终目录里头的内容如下:

目录结构

然后再回到Workflow设置页面设置一下keyword和调用Python脚本的方法和参数就OK了。

QQ20150511-7@2x

同理可以再设置一个HexToRGB的行为:

QQ20150511-8@2x

转换成功到了之后,我们把结果保存到剪贴板中,并且通过鼠标拖拽Script Filter节点上的小圆点到Copy to Clipboard节点上,这样就能把Script Filter中获得的结果保存到系统的剪贴板中了。

Screen Shot 2015-05-11 at 11.35.16 PM

最后来个实际使用的截图吧:

Screen Shot 2015-05-11 at 11.38.12 PM

折腾完毕。

Unity3D插件之Behavior Designer Movement Pack For Apex Path的巨坑

在目前的项目中,我们有使用到一个叫Apex Path的插件来做自动寻路的事情,这个插件整体来说还是棒棒哒,完全对得起$65的价格,我在写这篇文章的时候,刚好这货又在做半价促销了,链接在此

今天先不展开聊这个Apex Path插件了,今天主要是要吐槽一下Behavior Designer插件的增强包Movement Pack,在初次接触到Behavior Designer插件之时,顿时觉得这货能帮忙解决AI行为树的大部分问题,立马买回来尝试了几把,发现真心不错,可以解决很多问题。然后在他们网站上发现还有一个额外的用于处理移动的增强包,果断再次入手。拿回来简单地测试了一番,感觉还不错。但是在后续的开发中,总是会发现一些奇怪的问题,大体的表现就是NPC完全在没有移动到应该移动到的攻击位置就开始攻击了以及类似的问题,而且这个问题是在有多个使用了Behavior Designer控制的NPC出现在场景中的时候才会出现。

这个真心奇了怪了,作为一个朝内程序猿,我一直都奔着崇洋媚外的态度来看待国外程序员大大们,一直认为他们好牛逼好牛逼,然后先入为主地认为是自己用得肯定有问题,多次检查了自己的代码,依然没能找到问题。最终我就只能搞了一个空场景,就放了两个NPC,让NPC做最简单的行为,把Log加上,尼玛最后知道真相的我,眼泪掉下来啊,有木有!

我们来看看Behavior Designer Movement Pack For Apex Path中Patrol脚本中关于Apex中UnitNavigationEventMessage回调的处理。

 // Add the waypoint back on the stack when the destination is reached
public override void Handle(UnitNavigationEventMessage message)
{
    switch (message.eventCode) {
        case UnitNavigationEventMessage.Event.WaypointReached:
            movableAgent.MoveTo(waypoints[waypointIndex].position, true);
            waypointIndex = (waypointIndex + 1) % waypoints.Length;
        break;
    }
}

然后我们对比一下Apex Path插件中自带的一个PatrolBehaviour脚本是如何处理这个UnitNavigationEventMessage的回调的。

        
void IHandleMessage.Handle(UnitNavigationEventMessage message)
{
    if (message.entity != this.gameObject || message.isHandled)
    {
        return;
    }

    if (message.eventCode == UnitNavigationEventMessage.Event.WaypointReached)
    {
        message.isHandled = true;
        MoveNext(true);
    } else if (message.eventCode == UnitNavigationEventMessage.Event.DestinationReached)
    {
        message.isHandled = true;
        StartCoroutine(DelayedMove());
    }
}

细心对比一下,我们就会发现,在后者的处理逻辑中,加入了一个关于这个消息的entity对象是否为当前脚本所绑定的GameObject对象的判断,如果当前接收到的消息不是当前这个GameObject发出的,是不做任何逻辑,直接return的。然后再回过头来看看Behavior Designer Movement Pack For Apex Path中的处理,你就知道问题出在哪儿了。

因为Apex Path的GameServices中的MessageBus实现机制是任何对象都可以通过GameServices.messageBus访问到这个全局静态的MessageBus对象,并且可以通过subscribe和unsubscribe方法来进行消息的订阅和取消订阅。也就因为这个任何MessageBus的全局机制,任意注册了的对象都会收到回调,所以我们需要在处理消息回调的时候自行判断这个消息是否是我们需要的,或者说需要判断这个消息是否是发给自己的。MessageBus的机制就是一个广播,只要有任何一个对象触发了事件,注册了消息的所有对象都会收到广播,所以需要收到广播消息的对象自行甄别这货是否是发给自己的。

Behavior Designer Movement Pack For Apex Path脚本中对于回调的处理显然是忽略了这个甄别的过程,所以就会出现一些完全不在意料之中的事情,一切都能解释得通了。

Opsive的这个团队在Behavior Designer的工作确实非常惊艳,让人竖大拇哥,但是在这种问题上犯错误只能让我觉得这是实习生做的,或者就是完全没有真正地使用过Apex Path,然后就直接推出了一个似是而非的Movement增强包,我是很不以为然的。今天看到这个Movement的插件还升级了,Update需要花费$10,鉴于这个问题,我想暂时还是不升级了,虽然我很想看看他们升级的版本中是否已经修复了这个低级错误,等我今天闲下来了,我得给他们发个邮件问问。


给Opsive团队发过邮件了,邮件回复说是新的版本中已经加入这个判断了,问题已经修复,回复内容如下:

Hello,

Thank you for letting me know. Have you imported the most recent version of the Apex Path integration off of the integrations page? This integration doesn’t include an ApexPathSteeringBase file. It only includes ApexPathMovement as the base class. Within that class there is a check for the GameObject:

        public virtual void Handle(UnitNavigationEventMessage message)

        {

            if (!message.entity.Equals(gameObject)) {

                return;

            }

            switch (message.eventCode) {

                case UnitNavigationEventMessage.Event.DestinationReached:

                    arrived = true;

                    break;

            }

        }

I am not setting message.isHandled to true because all I am doing when destination is reached is setting a flag so a new destination hasn’t been set yet.

Thank you,

Justin

Unity3D Mecanim动画AnimatorTransitionInfo和AnimatorStateInfo在角色移动和待机平滑切换中的应用

在之前的开发过程中一直仅仅使用到了AnimatorStateInfo这货,平时在做一些判断的时候还特意加入一个判断!Animator.IsInTransition(0)来确定当前这个Animator没有在进行动画过渡,可是这几天同事们总是反应游戏中主角移动起步很慢和停止移动的时候会出现滑步的情况,这个不能忍,听得我很是汗颜啊。

好吧,汗颜的事情就先不表了,我们来看看这个可能是神马问题吧。通常我们游戏当中,角色都会有一个待机的动作,跑步和行走都会有相应地动作,而不同的动作之间的切换,Unity3D会自行做动画融合,这样主角从待机动作切换到跑步的动作时,就不会出现一帧直接切换导致看起来非常机械和卡顿的问题,看起来整个过程会是非常平滑的,这个就是我们要谈到的重点了。

在之前的实现中,我在主角的移动控制脚本PlayerMovement中使用了一段这样的代码来判断当前女主角已经成功的从Idle状态切换到Locomotion状态了

AnimatorStateInfo animInfo = animator.GetCurrentAnimatorStateInfo (0);
if (animInfo.isName ("Locomotion")) {
    // 这里控制角色的位置移动
}

然后在控制角色位置移动的代码段中,我们根据需要进行计算获得女主角在不同坐标上的移动位置,然后将位移作用到角色上。

但是这样做会有什么问题呢?

  • 首先,当角色在从Idle切换到Locomotion动画的过渡中时,上面的这段代码会直接忽略动画过渡的这段时间,所以在女主角从静止起步到跑步的过程中,Animator实际上一直都会保持为Idle的状态,直到整个Transition完成了,Animator的State才会切换到Locomotion,这样的话女主角实际上是在原地播放了这个过渡的动画,而这段时间的动画中,女主角的脚步会从静止切换到小碎步,再到大步跑,而这个时候女主角的位置不会发生变化(没有在女主角跑动动画对应的方向上移动),最终的结果就是主角看起来反应非常慢,起步的时候会出现卡顿,要在原地跑一段时间之后才会移动,这显然是不能接受的。
  • 其次,当角色从Locomotion切换到Idle动画的过渡中时,依然会出现逻辑被忽略的情况,也就是角色实际上已经在从Locomotion切换到Idle了,角色的脚步动作越来越小了,但是因为Animator的设计是在切换过程中,State的名字不会改变,会保持为状态切换之前的状态名,也就是在动画完全切换到Idle之前,State的名字一直都是Locomotion,所以主角在这个时间里头,逻辑会让主角继续运动(因为它满足上面的逻辑,所以还会计算位移,并应用到角色对象上),最终的结果就是看起来主角的跑步动画已经停止但是身体还在动画方向上做位移,出现滑步了,尼玛啊。

既然已经找到问题了,那么我们就肯定有办法来解决它。既然我们知道了动画在切换的过程中可以通过AnimatorTransitionInfo来获取过渡的信息,那么就有办法了,首先我们能确定Idle到Locomotion和Locomotion到Idle的nameHash值,通过比对这两个值就能明确知道当前Animator是从哪个状态切换到哪个状态了,然后根据AnimatorTransitionInfo.normalizedTime可以获取到过渡的进度信息,这样一来我们就能准确的计算出来动画过渡的过程中,角色应有的运动速度了,例如从Idle切换到Locomotion是从速度0到速度4m/s,那么在Idle切换到Locomotion的过程中通过Mathf.Lerp (04normalizedTime)就可以获取实时速度了。最终代码如下:

int hashIdle2Locomotion = Animator.StringToHash ("Base Layer.Idle -> Base Layer.Locomotion");
int hashLocomotion2Idle = Animator.StringToHash ("Base Layer.Locomotion -> Base Layer.Idle");
float moveSpeed = 4f;
float speed = 0f;    
if (animator.IsInTransition (0)) {
    AnimatorTransitionInfo transitionInfo = animator.GetAnimatorTransitionInfo (0);
    float normalizedTime = transitionInfo.normalizedTime;
    if (transitionInfo.nameHash == hashIdle2Locomotion) {
        speed = Mathf.Lerp (0, moveSpeed, normalizedTime);
    } else if (transitionInfo.nameHash == hashLocomotion2Idle) {
        speed = Mathf.Lerp (moveSpeed, 0, normalizedTime);
    }
} else if (animInfo.IsName ("Locomotion")) {
    speed = moveSpeed;
} else if (animInfo.IsName ("Idle")) {
    speed = 0f;
}