Epok Engine

EPOK RUNTIME

epok::World2DLibrary::overlap_box_2d

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Actors whose Collider2D bounds overlap the box centred on `center` with `half_extents`.

Belongs to
epok::World2DLibrary
Header
gameplay_api.hpp
Overloads
1

Declaration

static
Declaration
static ObjectBatch8 overlap_box_2d(GameplayVector2 center,GameplayVector2 half_extents,uint32_t mask,bool triggers)

Actors whose Collider2D bounds overlap the box centred on `center` with `half_extents`.

ParameterTypeMeaning
centerGameplayVector2Not documented; consult the linked header.
half_extentsGameplayVector2Not documented; consult the linked header.
maskuint32_tNot documented; consult the linked header.
triggersboolNot documented; consult the linked header.

Returns: ObjectBatch8. Consult the linked header for its meaning.

Example sketch

C++ example
#include "gameplay_api.hpp"

// Assume these named values have been initialized with valid data:
// GameplayVector2 center
// GameplayVector2 half_extents
// uint32_t mask
// bool triggers

auto result = epok::World2DLibrary::overlap_box_2d(center, half_extents, mask, triggers);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/gameplay_api.hpp:338

Related members