Skip to content

EPOK RUNTIME

Gameplay Api

gameplay_api.hpp · the gameplay api module

Module

the gameplay api module.

Header: gameplay_api.hpp
Include: #include "gameplay_api.hpp"
Stability: Epok runtime API

Include this module

C++ include

#include "gameplay_api.hpp"

Types

CardFileSampleStruct declared by the gameplay-api module for the gameplay api module.Struct CollisionHitSampleStruct declared by the gameplay-api module for the gameplay api module.Struct CollisionLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct FogSettingsPer-scene distance fog.Struct GameplayAabbStruct declared by the gameplay-api module for the gameplay api module.Struct GameplayCamera2DStruct declared by the gameplay-api module for the gameplay api module.Struct GameplayPlaybackSnapshotStruct declared by the gameplay-api module for the gameplay api module.Struct GameplayTransitionOptionsStruct declared by the gameplay-api module for the gameplay api module.Struct GameplayTransitionSnapshotStruct declared by the gameplay-api module for the gameplay api module.Struct GameplayVector2Struct declared by the gameplay-api module for the gameplay api module.Struct GameplayVector3Struct declared by the gameplay-api module for the gameplay api module.Struct GameplayVector3TweenStateA Vector3 tween is one clock plus two endpoints.Struct InputAxisSampleStruct declared by the gameplay-api module for the gameplay api module.Struct InputLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct MathLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct MemoryCardLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct MemoryCardSnapshotStruct declared by the gameplay-api module for the gameplay api module.Struct MovementIntentA dead-zoned analog stick reduced to a planar direction and a strength.Struct MoveSampleStruct declared by the gameplay-api module for the gameplay api module.Struct PlaybackLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct ProjectedPointStruct declared by the gameplay-api module for the gameplay api module.Struct ResourceLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct ResourceSnapshotStruct declared by the gameplay-api module for the gameplay api module.Struct SavePayload8Struct declared by the gameplay-api module for the gameplay api module.Struct SceneLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct SceneSnapshotStruct declared by the gameplay-api module for the gameplay api module.Struct SkeletalQuerySnapshotStruct declared by the gameplay-api module for the gameplay api module.Struct TimeLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct TimeSnapshotStruct declared by the gameplay-api module for the gameplay api module.Struct UtilityVectorLibraryThe Vector3 half of the `utilities` group.Struct Vector3TweenAdvanceSampleStruct declared by the gameplay-api module for the gameplay api module.Struct World2DLibraryStruct declared by the gameplay-api module for the gameplay api module.Struct

Functions and methods

active_camera_actorPerforms `active camera actor` as part of the gameplay api module.Method addAdds add as part of the gameplay api module.Method analogPerforms `analog` as part of the gameplay api module.Method axisPerforms `axis` as part of the gameplay api module.Method burst_effectPerforms `burst effect` as part of the gameplay api module.Method clampPerforms `clamp` as part of the gameplay api module.Method clear_skeletal_queriesClears skeletal queries as part of the gameplay api module.Method clear_staged_payloadClears staged payload as part of the gameplay api module.Method connectedPerforms `connected` as part of the gameplay api module.Method cosine_degreesPerforms `cosine degrees` as part of the gameplay api module.Method delta_degreesShortest signed turn from one heading to another, in -180..180.Method effect_sequencePerforms `effect sequence` as part of the gameplay api module.Method effect_statePerforms `effect state` as part of the gameplay api module.Method filePerforms `file` as part of the gameplay api module.Method fogPerforms `fog` 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 gameplay_actor_dataPerforms `gameplay actor data` as part of the gameplay api module.Function gameplay_actor_idPerforms `gameplay actor id` as part of the gameplay api module.Function gameplay_card_slot_namePerforms `gameplay card slot name` as part of the gameplay api module.Function gameplay_i16Performs `gameplay i16` as part of the gameplay api module.Function gameplay_save_wordsPerforms `gameplay save words` as part of the gameplay api module.Function gameplay_u16Performs `gameplay u16` as part of the gameplay api module.Function gameplay_u8Performs `gameplay u8` as part of the gameplay api module.Function gameplay_vectorPerforms `gameplay vector` as part of the gameplay api module.Function gameplay_vector_tweenPerforms `gameplay vector tween` as part of the gameplay api module.Function gameplay_vector_tween_valuePerforms `gameplay vector tween value` as part of the gameplay api module.Function groundPerforms `ground` as part of the gameplay api module.Method heading_degreesHeading of a planar vector in degrees, measured from +y towards +x, so a stick pushed forward reads 0 and a stick pushed right reads 90.Method heldPerforms `held` as part of the gameplay api module.Method lengthPerforms `length` as part of the gameplay api module.Method length2Performs `length2` as part of the gameplay api module.Method lerpPerforms `lerp` as part of the gameplay api module.Method listPerforms `list` as part of the gameplay api module.Method loaded_wordLoads ed word as part of the gameplay api module.Method movePerforms `move` as part of the gameplay api module.Method move_towardPerforms `move toward` as part of the gameplay api module.Method move_toward_degreesThe same approach on a circle: turns the short way and never overshoots.Method overlap_boxPerforms `overlap box` as part of the gameplay api module.Method pause_effectPauses effect as part of the gameplay api module.Method pause_sequencePauses sequence as part of the gameplay api module.Method pausedPauses d as part of the gameplay api module.Method payloadPerforms `payload` as part of the gameplay api module.Method play_effectStarts effect as part of the gameplay api module.Method play_sequenceStarts sequence as part of the gameplay api module.Method pressedPerforms `pressed` as part of the gameplay api module.Method probePerforms `probe` as part of the gameplay api module.Method projectPerforms `project` as part of the gameplay api module.Method raycast_segmentPerforms `raycast segment` as part of the gameplay api module.Method readReads read as part of the gameplay api module.Method releasedPerforms `released` as part of the gameplay api module.Method requestRequests request as part of the gameplay api module.Method request_with_transitionRequests with transition as part of the gameplay api module.Method resume_effectResumes effect as part of the gameplay api module.Method resume_sequenceResumes sequence as part of the gameplay api module.Method scalePerforms `scale` as part of the gameplay api module.Method screen_fadeThe post-HUD fade to black, 0 clear to 255 opaque, clamped rather than rejected because every amount above the range has one nearest valid value.Method screen_to_worldPerforms `screen to world` as part of the gameplay api module.Method sequence_statePerforms `sequence state` as part of the gameplay api module.Method set_cameraSets camera as part of the gameplay api module.Method set_fogSets fog as part of the gameplay api module.Method set_pausedSets paused as part of the gameplay api module.Method set_screen_fadeSets screen fade as part of the gameplay api module.Method set_staged_wordSets staged word as part of the gameplay api module.Method sine_degreesTrigonometry, roots and angle arithmetic in the engine's own Q12 form.Method skeletal_queriesPerforms `skeletal queries` as part of the gameplay api module.Method smoothstepPerforms `smoothstep` as part of the gameplay api module.Method snapshotPerforms `snapshot` as part of the gameplay api module.Method snapshotPerforms `snapshot` as part of the gameplay api module.Method snapshotPerforms `snapshot` as part of the gameplay api module.Method snapshotPerforms `snapshot` as part of the gameplay api module.Method square_rootPerforms `square root` as part of the gameplay api module.Method staged_wordPerforms `staged word` as part of the gameplay api module.Method stick_dead_zoneThe engine's standard analog dead zone, as a share of full deflection.Method stick_intentPerforms `stick intent` as part of the gameplay api module.Method stop_effectStops effect as part of the gameplay api module.Method stop_sequenceStops sequence as part of the gameplay api module.Method subtractPerforms `subtract` as part of the gameplay api module.Method transition_snapshotPerforms `transition snapshot` as part of the gameplay api module.Method vector_tween_advancePerforms `vector tween advance` as part of the gameplay api module.Method vector_tween_cancelPerforms `vector tween cancel` as part of the gameplay api module.Method vector_tween_schedulePerforms `vector tween schedule` as part of the gameplay api module.Method vector_tween_startPerforms `vector tween start` as part of the gameplay api module.Method vector_tween_valuePerforms `vector tween value` as part of the gameplay api module.Method vector3Performs `vector3` as part of the gameplay api module.Method world_to_screenPerforms `world to screen` as part of the gameplay api module.Method wrap_degrees0 <= result < 360.Method writeWrites write as part of the gameplay api module.Method write_stagedWrites staged as part of the gameplay api module.Method

Fields, variables and values

activeExposes `active` on `epok::SceneSnapshot` for the gameplay api module.Field active_slotsExposes `active_slots` on `epok::ResourceSnapshot` for the gameplay api module.Field active_texture_bytesExposes `active_texture_bytes` on `epok::ResourceSnapshot` for the gameplay api module.Field actorExposes `actor` on `epok::CollisionHitSample` for the gameplay api module.Field actorExposes `actor` on `epok::MoveSample` for the gameplay api module.Field alive_slotsExposes `alive_slots` on `epok::ResourceSnapshot` for the gameplay api module.Field analogExposes `analog` on `epok::InputAxisSample` for the gameplay api module.Field audio_gainExposes `audio_gain` on `epok::GameplayTransitionSnapshot` for the gameplay api module.Field blockedExposes `blocked` on `epok::MoveSample` for the gameplay api module.Field blocksExposes `blocks` on `epok::CardFileSample` for the gameplay api module.Field blueExposes `blue` on `epok::FogSettings` for the gameplay api module.Field blueExposes `blue` on `epok::GameplayTransitionOptions` for the gameplay api module.Field bonesExposes `bones` on `epok::SkeletalQuerySnapshot` for the gameplay api module.Field busyExposes `busy` on `epok::GameplayTransitionSnapshot` for the gameplay api module.Field callsExposes `calls` on `epok::SkeletalQuerySnapshot` for the gameplay api module.Field completedExposes `completed` on `epok::MemoryCardSnapshot` for the gameplay api module.Field completedExposes `completed` on `epok::Vector3TweenAdvanceSample` for the gameplay api module.Field connectedExposes `connected` on `epok::InputAxisSample` for the gameplay api module.Field decoded_bytesExposes `decoded_bytes` on `epok::SkeletalQuerySnapshot` for the gameplay api module.Field displacementExposes `displacement` on `epok::MoveSample` for the gameplay api module.Field dropped_primitivesExposes `dropped_primitives` on `epok::ResourceSnapshot` for the gameplay api module.Field dropped_stepsExposes `dropped_steps` on `epok::TimeSnapshot` for the gameplay api module.Field enabledExposes `enabled` on `epok::FogSettings` for the gameplay api module.Field end_distanceExposes `end_distance` on `epok::FogSettings` for the gameplay api module.Field errorExposes `error` on `epok::MemoryCardSnapshot` for the gameplay api module.Field fade_in_msExposes `fade_in_ms` on `epok::GameplayTransitionOptions` for the gameplay api module.Field fade_out_msExposes `fade_out_ms` on `epok::GameplayTransitionOptions` for the gameplay api module.Field failuresExposes `failures` on `epok::SkeletalQuerySnapshot` for the gameplay api module.Field file_countExposes `file_count` on `epok::MemoryCardSnapshot` for the gameplay api module.Field fixed_deltaExposes `fixed_delta` on `epok::TimeSnapshot` for the gameplay api module.Field fractionExposes `fraction` on `epok::CollisionHitSample` for the gameplay api module.Field frame_microsecondsExposes `frame_microseconds` on `epok::TimeSnapshot` for the gameplay api module.Field frame_scanlinesExposes `frame_scanlines` on `epok::ResourceSnapshot` for the gameplay api module.Field fromExposes `from` on `epok::GameplayVector3TweenState` for the gameplay api module.Field greenExposes `green` on `epok::FogSettings` for the gameplay api module.Field greenExposes `green` on `epok::GameplayTransitionOptions` for the gameplay api module.Field groundedExposes `grounded` on `epok::MoveSample` for the gameplay api module.Field hitExposes `hit` on `epok::CollisionHitSample` for the gameplay api module.Field last_rejectionExposes `last_rejection` on `epok::MemoryCardSnapshot` for the gameplay api module.Field loadingExposes `loading` on `epok::SceneSnapshot` for the gameplay api module.Field maximumExposes `maximum` on `epok::GameplayAabb` for the gameplay api module.Field mesh_trianglesExposes `mesh_triangles` on `epok::ResourceSnapshot` for the gameplay api module.Field minimumExposes `minimum` on `epok::GameplayAabb` for the gameplay api module.Field name_hashExposes `name_hash` on `epok::CardFileSample` for the gameplay api module.Field normalExposes `normal` on `epok::CollisionHitSample` for the gameplay api module.Field normalExposes `normal` on `epok::MoveSample` for the gameplay api module.Field opacityExposes `opacity` on `epok::GameplayTransitionSnapshot` for the gameplay api module.Field operationExposes `operation` on `epok::MemoryCardSnapshot` for the gameplay api module.Field particle_droppedExposes `particle_dropped` on `epok::ResourceSnapshot` for the gameplay api module.Field particle_peakExposes `particle_peak` on `epok::ResourceSnapshot` for the gameplay api module.Field particlesExposes `particles` on `epok::ResourceSnapshot` for the gameplay api module.Field pausedExposes `paused` on `epok::TimeSnapshot` for the gameplay api module.Field payload_bytesExposes `payload_bytes` on `epok::MemoryCardSnapshot` for the gameplay api module.Field phaseExposes `phase` on `epok::GameplayTransitionSnapshot` for the gameplay api module.Field pointExposes `point` on `epok::CollisionHitSample` for the gameplay api module.Field positionExposes `position` on `epok::GameplayCamera2D` for the gameplay api module.Field presentedExposes `presented` on `epok::GameplayTransitionSnapshot` for the gameplay api module.Field redExposes `red` on `epok::FogSettings` for the gameplay api module.Field redExposes `red` on `epok::GameplayTransitionOptions` for the gameplay api module.Field rejectedExposes `rejected` on `epok::SceneSnapshot` for the gameplay api module.Field requestExposes `request` on `epok::MemoryCardSnapshot` for the gameplay api module.Field resident_texture_bytesExposes `resident_texture_bytes` on `epok::ResourceSnapshot` for the gameplay api module.Field resultExposes `result` on `epok::GameplayPlaybackSnapshot` for the gameplay api module.Field revisionExposes `revision` on `epok::GameplayPlaybackSnapshot` for the gameplay api module.Field rotationExposes `rotation` on `epok::GameplayCamera2D` for the gameplay api module.Field scene_banksExposes `scene_banks` on `epok::ResourceSnapshot` for the gameplay api module.Field simulation_ticksExposes `simulation_ticks` on `epok::TimeSnapshot` for the gameplay api module.Field slot_capacityExposes `slot_capacity` on `epok::ResourceSnapshot` for the gameplay api module.Field sprite_trianglesExposes `sprite_triangles` on `epok::ResourceSnapshot` for the gameplay api module.Field start_distanceExposes `start_distance` on `epok::FogSettings` for the gameplay api module.Field started_insideExposes `started_inside` on `epok::CollisionHitSample` for the gameplay api module.Field stateExposes `state` on `epok::MemoryCardSnapshot` for the gameplay api module.Field stateExposes `state` on `epok::Vector3TweenAdvanceSample` for the gameplay api module.Field strengthExposes `strength` on `epok::MovementIntent` for the gameplay api module.Field successExposes `success` on `epok::ProjectedPoint` for the gameplay api module.Field texturesExposes `textures` on `epok::ResourceSnapshot` for the gameplay api module.Field timingExposes `timing` on `epok::GameplayVector3TweenState` for the gameplay api module.Field toExposes `to` on `epok::GameplayVector3TweenState` for the gameplay api module.Field transitionsExposes `transitions` on `epok::SceneSnapshot` for the gameplay api module.Field unresolved_overlapExposes `unresolved_overlap` on `epok::MoveSample` for the gameplay api module.Field validExposes `valid` on `epok::CardFileSample` for the gameplay api module.Field validExposes `valid` on `epok::MoveSample` for the gameplay api module.Field valueExposes `value` on `epok::InputAxisSample` for the gameplay api module.Field valueExposes `value` on `epok::Vector3TweenAdvanceSample` for the gameplay api module.Field verticesExposes `vertices` on `epok::SkeletalQuerySnapshot` for the gameplay api module.Field viewport_heightExposes `viewport_height` on `epok::GameplayCamera2D` for the gameplay api module.Field viewport_widthExposes `viewport_width` on `epok::GameplayCamera2D` for the gameplay api module.Field viewport_xExposes `viewport_x` on `epok::GameplayCamera2D` for the gameplay api module.Field viewport_yExposes `viewport_y` on `epok::GameplayCamera2D` for the gameplay api module.Field waitingExposes `waiting` on `epok::SceneSnapshot` for the gameplay api module.Field word0Exposes `word0` on `epok::SavePayload8` for the gameplay api module.Field word1Exposes `word1` on `epok::SavePayload8` for the gameplay api module.Field word2Exposes `word2` on `epok::SavePayload8` for the gameplay api module.Field word3Exposes `word3` on `epok::SavePayload8` for the gameplay api module.Field word4Exposes `word4` on `epok::SavePayload8` for the gameplay api module.Field word5Exposes `word5` on `epok::SavePayload8` for the gameplay api module.Field word6Exposes `word6` on `epok::SavePayload8` for the gameplay api module.Field word7Exposes `word7` on `epok::SavePayload8` for the gameplay api module.Field xExposes `x` on `epok::GameplayVector2` for the gameplay api module.Field xExposes `x` on `epok::GameplayVector3` for the gameplay api module.Field xExposes `x` on `epok::MovementIntent` for the gameplay api module.Field xExposes `x` on `epok::ProjectedPoint` for the gameplay api module.Field yExposes `y` on `epok::GameplayVector2` for the gameplay api module.Field yExposes `y` on `epok::GameplayVector3` for the gameplay api module.Field yExposes `y` on `epok::MovementIntent` for the gameplay api module.Field yExposes `y` on `epok::ProjectedPoint` for the gameplay api module.Field zExposes `z` on `epok::GameplayVector3` for the gameplay api module.Field zoomExposes `zoom` on `epok::GameplayCamera2D` for the gameplay api module.Field