EPOK RUNTIME

epok::InputLibrary::held

Method · 1 overload

Method

Performs `held` as part of the gameplay api module.

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

Declaration

static

Declaration

static bool held(Button button,uint32_t port)

Performs `held` as part of the gameplay api module.

Parameter	Type	Meaning
`button`	`Button`	Value supplied for button. Keep referenced or pointed-to data valid for the complete call.
`port`	`uint32_t`	Value supplied for port. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example

#include "gameplay_api.hpp"

// Assume these named values have been initialized with valid data:
// Button button
// uint32_t port

auto result = epok::InputLibrary::held(button, port);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations.

Declared in runtime/gameplay_api.hpp:136

Related members

analogPerforms `analog` as part of the gameplay api module.Method axisPerforms `axis` as part of the gameplay api module.Method connectedPerforms `connected` as part of the gameplay api module.Method frame_pressedPerforms `frame pressed` as part of the gameplay api module.Method frame_releasedPerforms `frame released` as part of the gameplay api module.Method pressedPerforms `pressed` as part of the gameplay api module.Method releasedPerforms `released` as part of the gameplay api module.Method