Unity3D 在自定义脚本中实现Button组件上的OnClick面板

Unity3D 在自定义脚本中实现Button组件上的OnClick面板

    • UnityEvent
    • 脚本代码
    • 事件传参
    • 多参数传入

下述内容不对c#语法做过多讲解,仅对已入门并有兴趣的同学做为学习和拓展的资料

大家在Unity制作的过程中一定都使用过UI功能,那么很多人也一定见过这个面板:
Unity3D 在自定义脚本中实现Button组件上的OnClick面板_第1张图片
那么我们如何能在自己的脚本中添加上像OnClick这样的面板呢。

UnityEvent

Unity中内置了一个UnityEvent类作为事件处理的类,我们只要在脚本中声明出来,Unity便会自动添加到脚本面板上,这样便可以在脚本之外添加移除事件,非常方便。

脚本代码

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;//需要引用命名空间

public class SelfScript : MonoBehaviour {

    public UnityEvent OnStartEvent;//声明公有变量
	// Use this for initialization
	void Start () {
        OnStartEvent.Invoke();//执行添加的事件
	}
	/// 
    /// 要执行的事件
    /// 
	public void OnStart()
    {
        print("-----OnStart Log");
    }
}

脚本写好后挂载到物体上,设置好执行的事件,运行查看结果
Unity3D 在自定义脚本中实现Button组件上的OnClick面板_第2张图片

Unity3D 在自定义脚本中实现Button组件上的OnClick面板_第3张图片

事件传参

如果需要向方法内传入参数的话,直接写出来即可

public void OnStart(string str)
{
    print("-----OnStart Log" + str);
}

Unity3D 在自定义脚本中实现Button组件上的OnClick面板_第4张图片
结果:
Unity3D 在自定义脚本中实现Button组件上的OnClick面板_第5张图片

其他任何类型的参数都可以这样传入,同样也可以传入Transform,Gameobject这样的对象。
这样的事件是不支持多参数的,最多只能传入一个参数。

多参数传入

事实上UnityEvent是支持多参数传入的,只不过必须通过脚本实现,一般情况下只会在制作一些易用的插件工具时会用到,
我用EasyTouch中的QuickSwipe来举例
Unity3D 在自定义脚本中实现Button组件上的OnClick面板_第6张图片
在事件声明的地方有这样一段代码


[System.Serializable] 
public class OnSwipeAction : UnityEvent<Gesture>{}

[SerializeField] 
public OnSwipeAction onSwipeAction;

通过API可知泛型UnityEvent是一个抽象类,所以想要实现只能通过类继承的方式来实现并声明泛型事件
此脚本只传入了一个参数,我们可以通过泛型来写入多个参数:


[System.Serializable]//想显示在面板上必须序列化该类
public class ValueEvent : UnityEvent<int,string,GameObject,SelfScript> { }//泛型中写入参数类型
public ValueEvent eventByValue;
void Start () {
    eventByValue.Invoke(5, " value ", gameObject, this);
}
public void OnValue(int i,string str,GameObject obj,SelfScript script)
{
        
    Debug.Log( string.Format( "-----OnValue: int:{0}, string: {1}, ObjName: {2}, script.gameobject.name: {3}",i,str,obj.name,script.gameObject.name));
}

UnityEvent最多支持4个不同类型参数的传入。
在这里插入图片描述
运行:
在这里插入图片描述
下面放出完整代码,需要的同学可直接复制:

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;//需要引用命名空间

public class SelfScript : MonoBehaviour {

    public UnityEvent OnStartEvent;//声明公有变量

    [System.Serializable]//想显示在面板上必须序列化该类
    public class ValueEvent : UnityEvent<int,string,GameObject,SelfScript> { }
    //[SerializeField]
    public ValueEvent eventByValue;
	// Use this for initialization
	void Start () {
        OnStartEvent.Invoke();//执行添加的事件
        eventByValue.Invoke(5, " value ", gameObject, this);
	}
	/// 
    /// 要执行的事件
    /// 
	public void OnStart(string str)
    {
        print("-----OnStart Log" + str);
    }
    public void OnValue(int i,string str,GameObject obj,SelfScript script)
    {
        
        print( string.Format( "-----OnValue: int:{0}, string: {1}, ObjName: {2}, script.gameobject.name: {3} ",i,str,obj.name,script.gameObject.name));
    }
}


你可能感兴趣的:(Unity脚本拓展)