core.h File Reference

Uncategorized functions for querying and manipulating game state. More...

Go to the source code of this file.

Functions
uint32_t	AERGetNumSteps (void)
	Query the number of steps (ticks) elapsed since the start of the game. More...
double	AERGetDeltaTime (void)
	Query the runtime of the previous step in seconds. More...
bool	AERGetPaused (void)
	Query the pause state of the game. More...

Detailed Description

Uncategorized functions for querying and manipulating game state.

Since

1.0.0

Copyright

2021 the libaermre authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Function Documentation

AERGetDeltaTime()

double AERGetDeltaTime

(

void

)

Query the runtime of the previous step in seconds.

The value returned by this function has microsecond precision.

Returns

Runtime in seconds or 0 if unsuccessful.

Exceptions

AER_SEQ_BREAK

if called outside action stage.

Since

1.5.0

AERGetNumSteps()

uint32_t AERGetNumSteps

(

void

)

Query the number of steps (ticks) elapsed since the start of the game.

Returns

Number of steps or 0 if unsuccessful.

Exceptions

AER_SEQ_BREAK

if called outside action stage.

Since

1.0.0

AERGetPaused()

bool AERGetPaused

(

void

)

Query the pause state of the game.

Returns

true if game is paused or false if unsuccessful or game is not paused.

Exceptions

AER_SEQ_BREAK

if called outside action stage.

Since

1.0.0

See also

AERModDef::gamePauseListener