note description: "[ Every high level events that are not attached to a specific component of the library (window, joystick, etc.) ]" author: "Louis Marchand" date: "Sat, 28 Feb 2015 19:01:23 +0000" revision: "2.0" deferred class interface GAME_COMMON_EVENTS feature -- Access clear -- Remove common library event. -- Note: does not clear other events like window events, joystick events, etc. To clear every events -- in the system, used GAME_LIBRARY_CONTROLLER.clear_all_events. ensure -- from GAME_EVENTS running_unchanged: is_running = old is_running events_controller: GAME_EVENTS_CONTROLLER -- Manage every internal events -- (from GAME_EVENTS) file_dropped_actions: ACTION_SEQUENCE [NATURAL_32, READABLE_STRING_GENERAL] -- Called when the file (or any other string) filename is drag and drop on a GAME_WINDOW. -- The event is not enabled by default. Use events_controller.enable_file_dropped_event to enable it. require joystick_found_event_enabled: events_controller.is_joy_device_founded_event_enable generating_type: TYPE [detachable GAME_COMMON_EVENTS] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty has_error: BOOLEAN -- Is the library has generate an error -- (from GAME_ERROR_MANAGER) is_running: BOOLEAN assign set_is_running -- Is Current active -- (from GAME_EVENTS) iteration_actions: ACTION_SEQUENCE [NATURAL_32] -- Called at each game loop joystick_found_actions: ACTION_SEQUENCE [NATURAL_32, GAME_JOYSTICK] -- Called when a new joystick has been founded -- Automatically added to GAME_LIBRARY_CONTROLLER.joysticks require joystick_found_event_enabled: events_controller.is_joy_device_founded_event_enable joystick_remove_actions: ACTION_SEQUENCE [NATURAL_32, GAME_JOYSTICK] -- Called when a new joystick has been removed -- The joystick will be removed from GAME_LIBRARY_CONTROLLER.joysticks after the -- calls of this feature. require joystick_remove_event_enabled: events_controller.is_joy_device_removed_event_enable last_error: READABLE_STRING_GENERAL -- The last error generate by the library -- (from GAME_SDL_ANY) quit_signal_actions: ACTION_SEQUENCE [NATURAL_32] -- When the application receive a quit signal. require quit_event_enabled: events_controller.is_quit_signal_event_enable run -- Put Current active. require -- from GAME_EVENTS run_not_already_running: not is_running ensure -- from GAME_EVENTS is_running: is_running set_is_running (a_value: BOOLEAN) -- Assign to is_running the value of a_value -- (from GAME_EVENTS) ensure -- from GAME_EVENTS is_assign: is_running ~ a_value stop -- Put Current innactive. require -- from GAME_EVENTS stop_is_running: is_running ensure -- from GAME_EVENTS is_stopped: not is_running feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: GAME_COMMON_EVENTS): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: GAME_COMMON_EVENTS): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: GAME_COMMON_EVENTS): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Duplication copy (other: GAME_COMMON_EVENTS) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: GAME_COMMON_EVENTS) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: GAME_COMMON_EVENTS -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: GAME_COMMON_EVENTS) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: GAME_COMMON_EVENTS -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: GAME_COMMON_EVENTS -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable GAME_COMMON_EVENTS -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class GAME_COMMON_EVENTS
Generated by ISE EiffelStudio