Epok Engine

EPOK RUNTIME

epok::CharacterBody2DComponent::is_on_floor

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

Reports whether on floor as part of the world2d components module.

Belongs to
epok::CharacterBody2DComponent
Header
world2d_components.hpp
Overloads
1

Declaration

const
Declaration
bool is_on_floor() const

Reports whether on floor as part of the world2d components module.

This overload takes no parameters.

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

Example sketch

C++ example
#include "world2d_components.hpp"

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

auto result = object.is_on_floor();

Trade-offs and warnings

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

Declared in runtime/world2d_components.hpp:437

Related members