运行时API
要使用Broccoli的运行时API,请在脚本中添加以下命名空间:
1 2 |
using Broccoli.Factory; using Broccoli.Pipe; |
static TreeFactory TreeFactory.GetFactory()
在运行时生成树的第一步是获取TreeFactory对象。该工厂将加载并使用管道在您的场景中生成树。建议在为场景中的每个管道的工厂都保留引用,以避免每次需要不同产品时再去加载新管道{由于TreeFactory.GetFactory()会创建工厂}。
1 |
TreeFactory myFactory = TreeFactory.GetFactory(); |
Pipeline TreeFactory.LoadPipeline(string pathToResource)
获得树工厂后,需要为它加载有效的管道。为了能够访问管道资产文件,应将其放在Resources文件夹中。请注意,pathToResource参数应符合Unity的资源格式,例如Assets / Resources / MyPipelines / myTreePipeline.asset中的文件将成为MyPipelines / myTreePipeline。如果无法加载管道,则该方法返回null。
1 |
Pipeline myPipeline = myFactory.LoadPipeline ("myPipelines/myTreePipeline"); |
bool Pipeline.IsValid()
检查管道是否有效,即是否可以进行树的生成。
1 |
if (myPipeline.IsValid ()) { Debug.Log ("Pipeline is valid!"); } |
GameObject TreeFactory.Spawn()
GameObject TreeFactory.Spawn(int seed)
如果一个树工厂加载了有效的管道,此方法基于此管道指令生成GameObject。每次调用spawn时,种子(seed)参数可以用来改变随机结果。
1 |
GameObject myTree = myTreeFactory.Spawn (); |