{"id":133,"date":"2021-07-23T11:18:11","date_gmt":"2021-07-23T16:18:11","guid":{"rendered":"https:\/\/chronocrash.com\/obor\/wiki\/?p=133"},"modified":"2024-01-12T23:19:46","modified_gmt":"2024-01-13T04:19:46","slug":"system-variables","status":"publish","type":"post","link":"https:\/\/chronocrash.com\/obor\/wiki\/system-variables\/","title":{"rendered":"System Variables"},"content":{"rendered":"\n

System variables are global variables within the engine that OpenBOR relies upon to conduct its various operations. OpenBOR script allows access to several of these through the openborvariant()<\/code> and setopenborvariant()<\/code> functions.<\/p>\n\n\n\n

Use Cases<\/h2>\n\n\n\n

Get a system value. Most system variables are integers. See the list of available variants for exceptions.<\/p>\n\n\n

\nmixed x = openborvariant(<string identifier>);\n<\/pre><\/div>\n\n\n
Modify a system value. Some OpenBOR variants are read only. See the list of available variants for details.<\/p>\n\n\n
\nmixed x = <value>;\n\nsetopenborvariant(<string identifier>, x);\n<\/pre><\/div>\n\n\n
    \n
  • Unless otherwise noted, any list of items in OpenBOR is 0 indexed. That means the first item is 0, the next is 1, and so on.<\/li>\n\n\n\n
  • Unless otherwise noted, all binary flags are 0 = False, 1 = True.<\/li>\n<\/ul>\n\n\n\n
    List<\/h3>\n\n\n\n
    Name<\/th>Type<\/a><\/th>Read Only<\/th>Description<\/th><\/tr><\/thead>
    background<\/code><\/td>Pointer<\/td><\/td>Current background screen. By creating a new screen and accessing its pointer, you can replace the current background in real time.<\/td><\/tr>
    blockade<\/code><\/td>Float<\/td><\/td>Scroll position mark where the player can no longer move.<\/td><\/tr>
    branchname<\/code><\/td>String<\/td>X<\/td>When a branch item is activated, this will indicate name of the level. Not recommended for most cases – use current_branch instead.<\/td><\/tr>
    cheats<\/code><\/td>Integer<\/td>X<\/td>Indicates if cheats have been enabled from the OpenBOR menu.<\/td><\/tr>
    count_enemies<\/code><\/td>Integer<\/td>X<\/td>Current number of enemy type entities in play.<\/td><\/tr>
    count_entities<\/code><\/td>Integer<\/td>X<\/td>Current number of entities in play.<\/td><\/tr>
    count_npcs<\/code><\/td>Integer<\/td>X<\/td>Current number of NPC type entities in play.<\/td><\/tr>
    count_players<\/code><\/td>Integer<\/td>X<\/td>Current number of player type entities in play.<\/td><\/tr>
    current_branch<\/code><\/td>String<\/td>X<\/td>Name of the current level branch.<\/td><\/tr>
    current_level<\/code><\/td>Integer<\/td>X<\/td>Level index of the current set.<\/td><\/tr>
    current_palette<\/code><\/td>Integer<\/td>X<\/td>Index of the current global palette in use. See level palettes for details on this feature.<\/td><\/tr>
    current_scene<\/code><\/td>String<\/td>X<\/td>File name of current scene.<\/td><\/tr>
    current_set<\/code><\/td>Integer<\/td>X<\/td>Index of the current set.<\/td><\/tr>
    current_stage<\/code><\/td>Integer<\/td>X<\/td>Current stage within a level.<\/td><\/tr>
    effectvol<\/code><\/td>Integer<\/td>X<\/td>Current menu setting for sound effect volume.<\/td><\/tr>
    elapsed_time<\/code><\/td>Integer<\/td><\/td>Global chronograph OpenBOR uses to track timing for virtually every engine operation. Note that is it not a perfect representation of real world time. Rather, the timer is a counter incremented on each engine update (~200 per second depending on hardware and conditions). Also note the timer is reset by certain events, such as a new level starting.<\/td><\/tr>
    ent_max<\/code><\/td>Integer<\/td>X<\/td>Maximum number of entities allowed in play.<\/td><\/tr>
    fps<\/code><\/td>Integer<\/td>X<\/td>Current engine update rate. Under optimal conditions, OpenBOR runs at 200FPS. ~60FPS is required for smooth game play.<\/td><\/tr>
    freeram<\/code><\/td>Integer<\/td>X<\/td>Available memory. As a 32bit application OpenBOR can “see” ~2GB of RAM according to the limits of your hardware and operating system.<\/td><\/tr>
    front_panel_z<\/code><\/td>Integer<\/td>X<\/td>Default position of front panel layer. Internally, it is a calculated offset from player_max_z<\/code>.<\/td><\/tr>
    game_paused<\/code><\/td><\/td><\/td>0<\/code> = Unpaused
    1<\/code> = Paused.<\/td><\/tr>
    game_speed<\/code><\/td><\/td><\/td><\/td><\/tr>
    game_time<\/code><\/td><\/td><\/td><\/td><\/tr>
    gfx_x_offset<\/code><\/td><\/td><\/td><\/td><\/tr>
    gfx_y_offset<\/code><\/td><\/td><\/td><\/td><\/tr>
    gfx_y_offset_adj<\/code><\/td><\/td><\/td><\/td><\/tr>
    global_config<\/code><\/td>Pointer<\/td>X<\/td>Pointer to the global configuration structure. See Global Config below.<\/td><\/tr>
    hresolution<\/code><\/td><\/td><\/td>Horizontal screen size.<\/td><\/tr>
    hole_z<\/code><\/td>Integer<\/td>X<\/td>Base layer position of Hole graphic. Internally, it is a calculated offset from player_min_z<\/code>.<\/td><\/tr>
    hud_common_load<\/code><\/td>Pointer<\/td>X<\/td>Pointer to Dial properties<\/a> for loading HUD.<\/td><\/tr>
    hud_common_main<\/code><\/td>Pointer<\/td>X<\/td>Pointer to Dial properties<\/a> for default HUD.<\/td><\/tr>
    hud_common_mp<\/code><\/td>Pointer<\/td>X<\/td>Pointer to Dial properties<\/a> for HUD mp display.<\/td><\/tr>
    hud_common_opponent<\/code><\/td>Pointer<\/td>X<\/td>Pointer to Dial properties<\/a> for HUD opponent display.<\/td><\/tr>
    hud_z<\/code><\/td>Integer<\/td>X<\/td>Base layer position of the heads up display (player\/enemy life, score, etc.) . Internally, it is a calculated offset from player_max_z<\/code>.<\/td><\/tr>
    in_cheat_options<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_control_options<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_enginecreditsscreen<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_gameoverscreen<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_halloffamescreen<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_level<\/code><\/td><\/td><\/td><\/td><\/tr>
    in_load_game<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_menuscreen<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_new_game<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_options<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_selectscreen<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_showcomplete<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_sound_options<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_start_game<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_system_options<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_titlescreen<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    in_video_options<\/code><\/td><\/td><\/td>Legacy. Use screen_status<\/code> instead.<\/td><\/tr>
    lasthita<\/code><\/td><\/td><\/td>Legacy. See lasthity<\/code>.<\/td><\/tr>
    lasthitc<\/code><\/td><\/td><\/td>Last hit confirm. Set true when engine detects a collision, then checked immediately before the hit reaction logic. You can set this to false during a doattack script to cancel a hit as if it never happened.<\/td><\/tr>
    lasthitt<\/code><\/td><\/td><\/td>Elapsed time when last hit occurred.<\/td><\/tr>
    lasthitx<\/code><\/td><\/td><\/td>X position (horizontal intersection between attack and body box) of last hit.<\/td><\/tr>
    lasthity<\/code><\/td><\/td><\/td>Y position (vertical intersection between attack and body box) of last hit.<\/td><\/tr>
    lasthitz<\/code><\/td><\/td><\/td>Z position (lateral intersection between attack and body box) of last hit.<\/td><\/tr>
    levelheight<\/code><\/td><\/td><\/td><\/td><\/tr>
    levelpos<\/code><\/td><\/td><\/td><\/td><\/tr>
    levelwidth<\/code><\/td><\/td><\/td><\/td><\/tr>
    lightx<\/code><\/td><\/td><\/td><\/td><\/tr>
    lightz<\/code><\/td><\/td><\/td><\/td><\/tr>
    max_wall_height<\/code><\/td>Integer<\/td><\/td>Highest wall entity may spawn on top of. Default = 1000.<\/td><\/tr>
    maxanimations<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    maxattacktypes<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    maxentityvars<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    maxglobalvars<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    maxindexedvars<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    maxplayers<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    maxscriptvars<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    maxsoundchannels<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    mirror_z<\/code><\/td>Integer<\/td>X<\/td>Base layer position of mirror effect panel. Internally, it is a calculated offset from player_min_z<\/code>.<\/td><\/tr>
    models_cached<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    models_loaded<\/code><\/td>Integer<\/td>X<\/td><\/td><\/tr>
    musicvol<\/code><\/td>Integer<\/td><\/td><\/td><\/tr>
    neon_panel_z<\/code><\/td>Integer<\/td>X<\/td>Base layer position of neon effect panel. Internally, it is a calculated offset from player_min_z<\/code>.<\/td><\/tr>
    nofadeout<\/code><\/td><\/td><\/td><\/td><\/tr>
    nogameover<\/code><\/td><\/td><\/td><\/td><\/tr>
    nohof<\/code><\/td><\/td><\/td><\/td><\/tr>
    nojoin<\/code><\/td><\/td><\/td><\/td><\/tr>
    nopause<\/code><\/td><\/td><\/td><\/td><\/tr>
    nosave<\/code><\/td><\/td><\/td><\/td><\/tr>
    noscreenshot<\/code><\/td><\/td><\/td><\/td><\/tr>
    noshowcomplete<\/code><\/td><\/td><\/td><\/td><\/tr>
    numbasemaps<\/code><\/td><\/td><\/td><\/td><\/tr>
    numholes<\/code><\/td><\/td><\/td><\/td><\/tr>
    numlayers<\/code><\/td><\/td><\/td><\/td><\/tr>
    numpalettes<\/code><\/td><\/td><\/td><\/td><\/tr>
    numwalls<\/code><\/td><\/td><\/td><\/td><\/tr>
    pakname<\/code><\/td><\/td><\/td><\/td><\/tr>
    panel_z<\/code><\/td>Integer<\/td>X<\/td>Base layer position of main panel. Internally, it is a calculated offset from player_min_z<\/code>.<\/td><\/tr>
    pause<\/code><\/td>Integer<\/td><\/td>See game_paused<\/code>.<\/td><\/tr>
    pixelformat<\/code><\/td><\/td><\/td><\/td><\/tr>
    player<\/code><\/td><\/td><\/td><\/td><\/tr>
    player_max_z<\/code><\/td>Integer<\/td><\/td>Highest allowed point on Z Axis<\/a> game field for active entities.<\/td><\/tr>
    player_min_z<\/code><\/td>Integer<\/td><\/td>Lowest allowed point on Z Axis<\/a> game field for active entities.<\/td><\/tr>
    player1<\/code><\/td><\/td><\/td><\/td><\/tr>
    player2<\/code><\/td><\/td><\/td><\/td><\/tr>
    player3<\/code><\/td><\/td><\/td><\/td><\/tr>
    player4<\/code><\/td><\/td><\/td><\/td><\/tr>
    porting<\/code><\/td><\/td><\/td><\/td><\/tr>
    sample_play_id<\/code><\/td><\/td><\/td><\/td><\/tr>
    screen_status<\/code><\/td>Integer<\/td><\/td>Current screen type. Bitwise with following constants. Note that some flags are not updated until reset at title screen:

    * openborconstant(\"IN_SCREEN_BUTTON_CONFIG_MENU\")<\/code> – In player button configuration menu. 
    * openborconstant(\"IN_SCREEN_CONTROL_OPTIONS_MENU\")<\/code> – In player control options.
    * openborconstant(\"IN_SCREEN_ENGINE_CREDIT\")<\/code> – Showing engine credits.
    * openborconstant(\"IN_SCREEN_GAME_OVER\")<\/code> – In game over screen.
    * openborconstant(\"IN_SCREEN_GAME_START_MENU\")<\/code> – In any game start menu.
    * openborconstant(\"IN_SCREEN_HALL_OF_FAME\")<\/code> – In Hall of Fame (high score listing).
    * openborconstant(\"IN_SCREEN_LOAD_GAME_MENU\")<\/code> – In load game menu.
    * openborconstant(\"IN_SCREEN_MENU\")<\/code> – In any menu.
    * openborconstant(\"IN_SCREEN_NEW_GAME_MENU\")<\/code> – In new game menu.
    * openborconstant(\"IN_SCREEN_OPTIONS_MENU\")<\/code> – Not in player screen.
    * openborconstant(\"IN_SCREEN_SELECT\")<\/code> – In select player screen.
    * openborconstant(\"IN_SCREEN_SHOW_COMPLETE\")<\/code> – In stage complete screen..
    * openborconstant(\"IN_SCREEN_SOUND_OPTIONS_MENU\")<\/code> – In sound settings menu.
    * openborconstant(\"IN_SCREEN_SYSTEM_OPTIONS_MENU\")<\/code> – In any options menu.
    * openborconstant(\"IN_SCREEN_TITLE\")<\/code> – Title screen.
    * openborconstant(\"IN_SCREEN_VIDEO_OPTIONS_MENU\")<\/code> – Setting video options.<\/td><\/tr>
    scrollmaxx<\/code><\/td><\/td><\/td><\/td><\/tr>
    scrollmaxz<\/code><\/td><\/td><\/td><\/td><\/tr>
    scrollminx<\/code><\/td><\/td><\/td><\/td><\/tr>
    scrollminz<\/code><\/td><\/td><\/td><\/td><\/tr>
    self<\/code><\/td><\/td><\/td><\/td><\/tr>
    sets_count<\/code><\/td>Integer<\/td>X<\/td>Current number of level sets (practice, easy, hard, etc.) loaded.<\/td><\/tr>
    shadow_z<\/code><\/td>Integer<\/td>X<\/td>Base layer position of shadow graphic. Internally, it is a calculated offset from player_min_z<\/code>.<\/td><\/tr>
    shadowalpha<\/code><\/td><\/td><\/td><\/td><\/tr>
    shadowcolor<\/code><\/td><\/td><\/td><\/td><\/tr>
    shadowopacity<\/code><\/td><\/td><\/td><\/td><\/tr>
    skiptoset<\/code><\/td><\/td><\/td><\/td><\/tr>
    slowmotion<\/code><\/td><\/td><\/td><\/td><\/tr>
    slowmotion_duration<\/code><\/td><\/td><\/td><\/td><\/tr>
    smartbomber<\/code><\/td><\/td><\/td><\/td><\/tr>
    soundvol<\/code><\/td><\/td><\/td><\/td><\/tr>
    textbox<\/code><\/td><\/td><\/td><\/td><\/tr>
    ticks<\/code><\/td><\/td><\/td><\/td><\/tr>
    totalram<\/code><\/td><\/td><\/td><\/td><\/tr>
    usedram<\/code><\/td><\/td><\/td><\/td><\/tr>
    viewporth<\/code><\/td><\/td><\/td><\/td><\/tr>
    viewportw<\/code><\/td><\/td><\/td><\/td><\/tr>
    viewportx<\/code><\/td><\/td><\/td><\/td><\/tr>
    viewporty<\/code><\/td><\/td><\/td><\/td><\/tr>
    vresolution<\/code><\/td>Integer<\/td><\/td>Vertical screen size.<\/td><\/tr>
    vscreen<\/code><\/td><\/td><\/td><\/td><\/tr>
    waiting<\/code><\/td><\/td><\/td><\/td><\/tr>
    xpos<\/code><\/td>Integer<\/td><\/td>Current horizontal scroll position in a level.<\/td><\/tr>
    ypos<\/code><\/td><\/td><\/td>Current vertical scroll position in a level.<\/td><\/tr><\/tbody>
    Name<\/td>Type<\/a><\/td>Read Only<\/td>Description<\/td><\/tr><\/tfoot><\/table><\/figure>\n\n\n\n
    Global Config<\/h2>\n\n\n\n
    Global config is an ongoing effort to consolidate some of the unwieldy number of global system variables into a more manageable structure. Global config properties are accessible with the get_global_config_property()<\/code> and set_global_config_property()<\/code> functions. You will first need to acquire the global config pointer using openborvariant(\"global_config\")<\/code>.<\/p>\n\n\n\n
    Name<\/th>Type<\/a><\/th>Description<\/th><\/tr><\/thead>
    openborconstant(\"GLOBAL_CONFIG_PROPERTY_AJSPECIAL\")<\/code><\/td>Integer<\/td>Button map for activating a player’s breakout special or smartbomb. See ajspecial<\/a>.<\/td><\/tr>
    openborconstant(\"GLOBAL_CONFIG_PROPERTY_BLOCK_RATIO\")<\/code><\/td>Integer<\/td>Models.txt blockratio<\/a>.<\/td><\/tr>
    openborconstant(\"GLOBAL_CONFIG_PROPERTY_BLOCK_TYPE\")<\/code><\/td>Integer<\/td>Models.txt mpblock<\/a>.<\/td><\/tr>
    openborconstant(\"GLOBAL_CONFIG_PROPERTY_CHEATS\")<\/code><\/td>Integer<\/td>Cheat menu and active cheat setup. See Cheats<\/a>.<\/td><\/tr>
    openborconstant(\"GLOBAL_CONFIG_PROPERTY_FLASH\")<\/code><\/td>Integer<\/td>Pointer to the global set of flash properties. See Hit Effects<\/a>.<\/td><\/tr>
    openborconstant(\"GLOBAL_CONFIG_PROPERTY_SHOW_GO\")<\/code><\/td>Integer<\/td>When 1, the go arrow is currently displayed.<\/td><\/tr><\/tbody>
    Name<\/td>Type<\/a><\/td>Description<\/td><\/tr><\/tfoot><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"
    Accessing engine’s internal variables.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[328,2],"tags":[126,127,5,4,257,3],"class_list":["post-133","post","type-post","status-publish","format-standard","hentry","category-openbor","category-script","tag-obor_func_openborvariant","tag-obor_func_setopenborvariant","tag-manual","tag-openbor-script","tag-systemvariant","tag-variables"],"revision_note":"","jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts\/133","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/comments?post=133"}],"version-history":[{"count":5,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts\/133\/revisions"}],"predecessor-version":[{"id":1393,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts\/133\/revisions\/1393"}],"wp:attachment":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/media?parent=133"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/categories?post=133"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/tags?post=133"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}