EPOK RUNTIME

epok::bp::root_component

Function template · 1 overload

Function template

Performs `root component` as part of compiled Blueprint execution and object interaction.

Belongs to: epok::bp
Header: actor_blueprint.hpp
Overloads: 1

Declaration

template

Declaration

template<class Root> Root* root_component(ObjectId id)

Performs `root component` as part of compiled Blueprint execution and object interaction.

Parameter	Type	Meaning
`id`	`ObjectId`	Value supplied for id. Keep referenced or pointed-to data valid for the complete call.

Returns: Root *. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example

#include "actor_blueprint.hpp"

// Replace these template arguments with types or values accepted by the declaration:
// Root

// Assume these named values have been initialized with valid data:
// ObjectId id

epok::bp& object = /* obtain a valid instance */;

auto result = object.root_component<Root>(id);

Why use it

Template dispatch is resolved at compile time and normally adds no runtime indirection.

Trade-offs and warnings

Every instantiated type must satisfy the header's compile-time requirements; extra instantiations can increase code size.

Declared in runtime/actor_blueprint.hpp:25

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function template aabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function template aabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Function aabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Function aabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Function aabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Function activate_texture_bankPerforms `activate texture bank` as part of the epok module.Function active_cameraPerforms `active camera` as part of the epok module.Function actor_for_slotPerforms `actor for slot` as part of the actor tables module.Function allocate_actor_dataPerforms `allocate actor data` as part of the epok module.Function attach_componentSpatial attachment between components of the same domain.Function audio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function