class_os

OS

Inherits: Object\n\n### Brief Description
Operating System functions.

Member Functions

• Vector2 get_mouse_pos" ( ) const
• void set_clipboard" ( String clipboard )
• String get_clipboard" ( ) const
• void set_video_mode" ( Vector2 size, bool fullscreen, bool resizable, int screen=0 )
• Vector2 get_video_mode_size" ( int screen=0 ) const
• bool is_video_mode_fullscreen" ( int screen=0 ) const
• bool is_video_mode_resizable" ( int screen=0 ) const
• Array get_fullscreen_mode_list" ( int screen=0 ) const
• void set_iterations_per_second" ( int iterations_per_second )
• int get_iterations_per_second" ( ) const
• bool has_touchscreen_ui_hint" ( ) const
• void set_low_processor_usage_mode" ( bool enable )
• bool is_in_low_processor_usage_mode" ( ) const
• int get_processor_count" ( ) const
• String get_executable_path" ( ) const
• int execute" ( String path, StringArray arguments, bool blocking )
• int kill" ( int pid )
• int shell_open" ( String uri )
• String get_environment" ( String environment ) const
• bool has_environment" ( String environment ) const
• String get_name" ( ) const
• StringArray get_cmdline_args" ( )
• Object get_main_loop" ( ) const
• Dictionary get_date" ( ) const
• Dictionary get_time" ( ) const
• int get_unix_time" ( ) const
• void set_icon" ( Image arg0 )
• void delay_usec" ( int usec ) const
• void delay_msec" ( int msec ) const
• int get_ticks_msec" ( ) const
• String get_locale" ( ) const
• String get_model_name" ( ) const
• String get_custom_level" ( ) const
• bool can_draw" ( ) const
• int get_frames_drawn" ( )
• bool is_stdout_verbose" ( ) const
• int get_mouse_button_state" ( ) const
• void dump_memory_to_file" ( String file )
• void dump_resources_to_file" ( String file )
• void print_resources_in_use" ( bool short=false )
• void print_all_resources" ( String tofile="" )
• int get_static_memory_usage" ( ) const
• int get_static_memory_peak_usage" ( ) const
• int get_dynamic_memory_usage" ( ) const
• String get_data_dir" ( ) const
• String get_unique_ID" ( ) const
• real get_frames_per_second" ( ) const

Numeric Constants

• DAY_SUNDAY = 0
• DAY_MONDAY = 1
• DAY_TUESDAY = 2
• DAY_WEDNESDAY = 3
• DAY_THURSDAY = 4
• DAY_FRIDAY = 5
• DAY_SATURDAY = 6
• MONTH_JANUARY = 0
• MONTH_FEBRUARY = 1
• MONTH_MARCH = 2
• MONTH_APRIL = 3
• MONTH_MAY = 4
• MONTH_JUNE = 5
• MONTH_JULY = 6
• MONTH_AUGUST = 7
• MONTH_SEPTEMBER = 8
• MONTH_OCTOBER = 9
• MONTH_NOVEMBER = 10
• MONTH_DECEMBER = 11

Description

Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: -Mouse Grabbing -Mouse Cursors
-Clipboard -Video Mode -Date " Time -Timers
-Environment Variables -Execution of Binaries -Command Line

Member Function Description

== get_mouse_pos ==

• Vector2 get_mouse_pos" ( ) const \ Return the mouse pos. == set_clipboard ==
• void set_clipboard" ( String clipboard ) \ Set clipboard to the OS. == get_clipboard ==
• String get_clipboard" ( ) const \ Get clipboard from the host OS. == set_video_mode ==
• void set_video_mode" ( Vector2 size, bool fullscreen, bool resizable, int screen=0 ) \ Change the video mode. == get_video_mode_size ==
• Vector2 get_video_mode_size" ( int screen=0 ) const \ Return the current video mode size. == is_video_mode_fullscreen ==
• bool is_video_mode_fullscreen" ( int screen=0 ) const \ Return true if the current video mode is fullscreen. == is_video_mode_resizable ==
• bool is_video_mode_resizable" ( int screen=0 ) const \ Return true if the window is resizable. == get_fullscreen_mode_list ==
• Array get_fullscreen_mode_list" ( int screen=0 ) const \ Return the list of fullscreen modes. == set_iterations_per_second ==
• void set_iterations_per_second" ( int iterations_per_second ) \ Set the amount of fixed iterations per second (for fixed process and physics). == get_iterations_per_second ==
• int get_iterations_per_second" ( ) const \ Return the amount of fixed iterations per second (for fixed process and physics). == set_low_processor_usage_mode ==
• void set_low_processor_usage_mode" ( bool enable ) \ Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu. == is_in_low_processor_usage_mode ==
• bool is_in_low_processor_usage_mode" ( ) const \ Return true if low cpu usage mode is enabled. == get_executable_path ==
• String get_executable_path" ( ) const \ Return the path tot he current engine executable. == execute ==
• int execute" ( String path, StringArray arguments, bool blocking ) \ Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. == kill ==
• int kill" ( int pid ) \ Kill a process ID. == get_environment ==
• String get_environment" ( String environment ) const \ Return an environment variable. == has_environment ==
• bool has_environment" ( String environment ) const \ Return true if an envieronment variable exists. == get_name ==
• String get_name" ( ) const \ Return the name of the host OS. == get_cmdline_args ==
• StringArray get_cmdline_args" ( ) \ Return the commandline passed to the engine. == get_main_loop ==
• Object get_main_loop" ( ) const \ Return the main loop object (see mainloop). == get_date ==
• Dictionary get_date" ( ) const \ Return the current date. == get_time ==
• Dictionary get_time" ( ) const \ Return the current time. == delay_usec ==
• void delay_usec" ( int usec ) const \ Delay executing of the current thread by given usecs. == get_ticks_msec ==
• int get_ticks_msec" ( ) const \ Return the amount of time passed in milliseconds since the engine started. == get_locale ==
• String get_locale" ( ) const \ Return the host OS locale. == can_draw ==
• bool can_draw" ( ) const \ Return true if the host OS allows drawing. == get_frames_drawn ==
• int get_frames_drawn" ( ) \ Return the total amount of frames drawn. == is_stdout_verbose ==
• bool is_stdout_verbose" ( ) const \ Return true if the engine was executed with -v (verbose stdout). == get_mouse_button_state ==
• int get_mouse_button_state" ( ) const \ Return the state of the mouse buttons (each button in each bit). == get_static_memory_peak_usage ==
• int get_static_memory_peak_usage" ( ) const \ Return the max amount of static memory used (only works in debug). == get_dynamic_memory_usage ==
• int get_dynamic_memory_usage" ( ) const \ Return the total amount of dynamic memory used (only works in debug).