View source

class Lib

package hxe

Static methods

staticbind(path:String, object:Dynamic):Void

Load the Prefab from path and assign all created hierarchy objects to fields of the object instance.

Parameters:

path

Prefab name. Can point to a subfolder and must be without an extension.

object

An instance to which the prefab adds itself and assigns fields from the loaded path hierarchy.

staticload(path:String, ?parent:Object, ?field:Array<Field>):Prefab

Load the Prefab with the given name path from the res folder. path can point to a subfolder (eg: "ui/button") and must be without an extension.

Parameters:

path

Prefab name.
parent

An optional parent h2d.Object instance to which prefab adds itself if set.
field

An optional Field structure to override default values ​​for an object in the prefab hierarchy(text, texture atlas tile. eg: "[{ name : "label", type : "text", value : "new label" }]").

staticmake(path:String, object:Prefab, ?field:Array<Field>):Void

Initializes an existing Prefab instance by loading a hierarchy from the given path and attaching all loaded objects as children of this prefab. The loaded hierarchy is stored in the hierarchy field, and any objects whose names match fields of this Prefab instance are automatically assigned to those fields.

Parameters:

path

Prefab name. Can point to a subfolder and must be without an extension.

object

An existing Prefab instance to initialize and populate with the loaded hierarchy.
field

An optional Field structure to override default values ​​for an object in the prefab hierarchy(text, texture atlas tile. eg: "[{ name : "label", type : "text", value : "new label" }]").

staticread(path:String):Data

Get json hxe.Lib.Data typedef of the Prefab with the given name path from the res folder.

staticsetCache(atlas:Atlas):Void


View source

class Prefab

package hxe

extends Object

@:directlyUsed

Constructor

new(?path:String, ?parent:Object, ?field:Array<Field>)

Creates a Prefab instance and loads its visual content from the prefab file at the specified path. The created objects are instantiated and attached to this prefab’s hierarchy using hxe.Lib.make.

Parameters:

path

Prefab name. Can point to a subfolder and must be without an extension.
parent

An optional parent h2d.Object instance to which prefab adds itself if set.
field

An optional Field structure to override default values ​​for an object in the prefab hierarchy(text, texture atlas tile. eg: "[{ name : "label", type : "text", value : "new label" }]").

Methods

as<T>(c:Class<T>):T

Converts the prefab to another c prefab class.

get<T:h2d.Object>(n:String, ?c:Class<T>):Null<T>

Get an object from the prefab hierarchy by name. If the optional class c is provided, the returned object is verified to be of that type, returning null if it does not match. If c is not provided, the object is returned directly(unsafe cast).

Parameters:

n

Name of the object in the hierarchy.
c

Optional class to enforce type checking.

all<T>(c:Class<T>, ?all:Array<T>):Array<T>

Find all objects of the given class c in the prefab hierarchy.

Parameters:

all

An optional array instance to fill results with. Allocates a new array if not set.

has(n:String):Bool

Check if the prefab has a object in the hierarchy with the given n name.

is<T>(c:Class<T>):Bool

Check if the prefab matches the given class c.

typeof(n:String):String

Get the class name of the object from the prefab hierarchy with the given name n.


Introduction

Quick Start

Working with editor

In-game implementation

API