Skip to content

Core Services API

These are the shared services and helper types you will most often use around the engine.

Window and display

  • Display
  • WindowFlag
  • CursorType

Start here if you want to manage the window, cursor, clipboard, fullscreen state, or monitor information.

Useful entry points:

  • Display module reference
  • create_window(width, height, title)
  • set_window_title(title)
  • toggle_fullscreen()
  • set_mouse_cursor(cursor)
  • get_monitor_size(monitor)

Rendering

  • Renderer2D
  • Renderer3D
  • Color
  • Rect
  • TextureFilter
  • ArepyTexture
  • ArepyFont
  • ArepyModel
  • ArepyMesh
  • ArepyMaterial

Start here if you want to draw sprites, text, shapes, models, debug primitives, or use cameras.

Useful entry points:

Input

  • Input
  • Key
  • MouseButton

Start here if you want keyboard, mouse, wheel, or typed text state.

Useful entry points:

  • Input module reference
  • is_key_pressed(key)
  • is_key_down(key)
  • is_mouse_button_pressed(button)
  • get_mouse_position()
  • get_char_pressed()

Audio

  • AudioDevice
  • ArepySound
  • ArepyMusic

Start here if you want to play sound effects, stream music, or control volume and playback time.

Useful entry points:

  • Audio module reference
  • load_sound(path)
  • play_sound(sound)
  • load_music(path)
  • play_music(music)
  • seek_music_stream(music, position)

Assets

  • AssetStore

Start here if you want a named store for textures, fonts, sounds, music, models, meshes, and materials.

Useful entry points:

Events

  • EventManager
  • Event

Start here if you want loose communication between systems or gameplay modules.

Useful entry points:

Where to keep reading

  • The generated module reference shows every method, attribute, and nested module.
  • The engine services guide explains what each service is for in plain language.
  • Read Engine Services for examples of how these services are injected into systems.