World

game and camera

Time, view state, icons, interface settings and the camera.

game

game.in_game()boolean
Whether you're in the world (not loading, at character select or in a cinematic).
game.view_state()integer
One of the game.VIEW_STATE_* constants.
game.loading_stage()integer
How far a map load is.
game.set_loading_stage(stage)
Sets the loading stage.
game.window_size()Vec2
The game window's size in pixels.
game.tick_count()integer
Ticks since the game started.
game.game_time()integer
The game clock, in milliseconds.
game.world_time()integer
The time of day in the world.
game.set_world_time(time)
Sets the time of day on your screen.
game.ping()integer
Your ping, in milliseconds.
game.timeouts()table?
{model, map, agent}: how long the game keeps unused models, maps and agents loaded.
game.steam()boolean
Whether the game runs through Steam.
game.color_blind_mode()boolean
Whether color-blind mode is on.
game.set_color_blind_mode(on)
Turns color-blind mode on or off.
game.drawings_enabled()boolean
Whether overlays are drawn.
game.set_drawings_enabled(on)
Turns overlays on or off.
game.profession_icon(profession [, big])Image?
A profession's icon, for ui.image and gfx.image.
game.spec_icon(spec [, big])Image?
A specialization's icon.
game.class_icon(profession, spec [, big])Image?
The icon for a profession with a specialization.
View states
VIEW_STATE_IN_GAMEVIEW_STATE_LOADING_SCREENVIEW_STATE_CHAR_SELECTVIEW_STATE_CINEMATICVIEW_STATE_SCOUT

professions

Profession and specialization ids, as professions.GUARDIAN and so on, for game.profession_icon, game.spec_icon and agent:profession().

Professions
GUARDIANWARRIORENGINEERRANGERTHIEFELEMENTALISTMESMERNECROMANCERREVENANT
Elite specializations
DRAGONHUNTERFIREBRANDWILLBENDERLUMINARYBERSERKERSPELLBREAKERBLADESWORNPARAGONSCRAPPERHOLOSMITHMECHANISTAMALGAMDRUIDSOULBEASTUNTAMEDGALESHOTDAREDEVILDEADEYESPECTERANTIQUARYTEMPESTWEAVERCATALYSTEVOKERCHRONOMANCERMIRAGEVIRTUOSOTROUBADOURREAPERSCOURGEHARBINGERRITUALISTHERALDRENEGADEVINDICATORCONDUIT

game_ui

The game's own interface settings.

game_ui.text_box_has_focus()boolean
Whether the player is typing in a text box, such as chat. Let keys through while this is true.
game_ui.interface_size()integer
0 small, 1 normal, 2 large, 3 larger.
game_ui.ground_targeting()integer
0 normal, 1 fast with range indicator, 2 instant.
game_ui.estate()integer
Raw interface state.
game_ui.set_language(lang)
"en", "fr", "de", "es" or "zh".

camera

camera.world_to_screen(pos)Vec2?
Where a world position is on screen; nil when it's behind the camera.
camera.screen_to_world()Vec3?
The world position under the mouse cursor.
camera.cast_ray(from, to)table?
The first thing between two points: {position, normal}.
camera.zoom()number?
The camera's zoom.
camera.max_zoom()number?
How far the camera can zoom out.
camera.set_max_zoom(value)
Sets how far it can zoom out.
camera.world_renderer_enabled()boolean
Whether the world is drawn.
camera.set_world_renderer_enabled(on)
Turns drawing the world on or off.
PreviousProgression