Entity类

指自定义实体的基类。 该类可对节点进行快速访问。

Entity类的实现存放在路径下文件data/framework/game/entity.h中。

Entity Class

成员

---

Entity ()

构造函数。 用来创建新Entity类的实例。

void init (string name, Level level, NodeReference ref)

其作用是初始化实体并将其绑定给节点引用。

参数

• string name - 指实体名称。
• Level level - 指实体所属的那个关卡（Level）。
• NodeReference ref - 指节点引用。

void shutdown ()

其作用是释放实体资源。

void onInit ()

指在实体初始化之后被调用的虚方法。 该方法默认为空。 实体的自定义逻辑可以在此实施。

void onUpdate ()

指在每个update()中都被调用的虚方法。 该方法默认为空。 实体的自定义逻辑可以在此实施。 如有所需，也可以禁用该方法。

void onFlush ()

指在每个flush()中都被调用的虚方法。 该方法默认为空。 实体的自定义逻辑可以在此实施。 如有所需，也可以禁用该方法。

void onRender ()

指在每个render()中都被调用的虚方法。 该方法默认为空。 实体的自定义逻辑可以在此实施。 如有所需，也可以禁用该方法。

void onShutdown ()

指在shutdown()之后调用的虚方法。 该方法默认为空。 实体的自定义逻辑可以在此实施。

void setEnabled (int mode)

其作用是开关实体和关联的节点引用。 其setter的属性特征（attribute）为[set_toggle: Enabled]。

参数

• int mode - 1，表示启用实体和节点引用；0，表示禁用它们。

int isEnabled ()

其作用是返回一个可用来表明实体是否被启用的值。 其getter的属性特征（attribute）为[get_toggle: Enabled]。

返回值

如果实体被启用就返回1；否则返回0。

void setRenderable (int mode)

其作用是开关onRender()函数的调用。 其setter的属性特征（attribute）为[set_toggle: Renderable]。

参数

• int mode - 1，表示启用onRender()函数的调用；0，表示禁用该函数的调用。

int isRenderable ()

其作用是返回一个可用来表明onRender()函数是否被调用的值。 其getter的属性特征（attribute）为[get_toggle: Renderable]。

返回值

如果onRender()函数被调用就返回1；否则返回0。

void setFlushable (int mode)

其作用是开关onFlush()函数的调用。 其setter的属性特征（attribute）为[set_toggle: Flushable]。

参数

• int mode - 1，表示启用onFlush()函数的调用；0，表示禁用该函数的调用。

int isFlushable ()

其作用是返回一个可用来表明onFlush()函数是否被调用的值。 其getter的属性特征（attribute）为[get_toggle: Flushable]。

返回值

如果onFlush()函数被调用就返回1；否则返回0。

void setUpdateable (int mode)

其作用是开关onUpdate()函数的调用。 其setter的属性特征（attribute）为[set_toggle: Updateable]。

参数

• int mode - 1，表示启用onUpdate()函数的调用；0，表示禁用该函数的调用。

int isUpdateable ()

其作用是返回一个可用来表明onUpdate()函数是否被调用的值。 其getter的属性特征（attribute）为[get_toggle: Updateable]。

返回值

如果onUpdate()函数被调用就返回1；否则返回0。

void setUpdateOrder (int order)

其作用是设置实体的更新顺序。 其setter的属性特征（attribute）为[set_switch: Update order]。

参数

• int order - 指更新顺序。 它可取0到16间的值。 其默认值为8。

int getUpdateOrder ()

其作用是返回更新顺序的值。 其getter的属性特征（attribute）为[get_switch: Update order:"-8,-7,-6,-5,-4,-3,-2,-1,default,+1,+2,+3,+4,+5,+6,+7,+8":8]。

返回值

更新顺序。 它可以是0到16间的值。

string getName ()

其作用是返回实体名称。

返回值

实体名称。

Level getLevel ()

其作用是返回当前关卡。

返回值

当前关卡。

Game getGame ()

其作用是返回当前游戏。

返回值

当前游戏。

NodeReference getNodeReference ()

其作用是返回与实体关联的节点引用（如果与实体关联的节点不是节点引用，就将返回assert宏(断言)）。

返回值

节点引用。

Node getRootNode ()

其作用是返回与实体关联的节点引用的根节点（如果与实体关联的节点不是节点引用，就将返回assert宏(断言)）。

返回值

根节点。

Node getNode ()

其作用是返回与实体关联的节点。

返回值

返回节点；如果该节点未找到，则返回NULL。

Node getNode (string name)

其作用是返回节点引用（或其它节点）的子节点中出现的第一个节点。

参数

• string name - 节点名称。

返回值

返回节点；如果该节点未找到，则返回NULL。

Vec3 getPosition ()

其作用是返回节点引用的位置。

返回值

节点引用的位置坐标。

void setPosition (Vec3 pos)

其作用是设置节点引用的位置。

参数

• Vec3 pos - 指节点引用的位置坐标。

Mat4 getTransform ()

其作用是返回节点引用的变换矩阵。

返回值

变换矩阵。

void setTransform (Mat4 t)

其作用是为节点引用设置变换矩阵。

参数

• Mat4 t - 指变换矩阵。

quat getRotation ()

其作用是返回节点引用的旋转。

返回值

节点引用在本地坐标（local space）中的旋转。

void setRotation (quat q)

其作用是设置节点引用的旋转。

参数

• quat q - 指节点引用在本地坐标（local space）中的旋转。