lib/gamnit/gamnit.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 # Game and multimedia framework for Nit
  16 module gamnit
  17
  18 import app
  19
  20 import display
  21 import textures
  22
  23 import gamnit_android is conditional(android)
  24
  25 redef class App
  26
  27         # Main `GamnitDisplay` initialized by `on_create`
  28         var display: nullable GamnitDisplay = null
  29
  30         redef fun on_create
  31         do
  32                 super
  33
  34                 var display = new GamnitDisplay
  35                 display.setup
  36                 self.display = display
  37         end
  38
  39         # Core of the frame logic, executed only when the display is visible
  40         #
  41         # This method should be redefined by user modules to customize the behavior of the game.
  42         protected fun frame_core do end
  43
  44         # Full frame logic, executed even if the display is not visible
  45         #
  46         # This method wraps `frame_core` and other services to be executed in the main app loop.
  47         #
  48         # To customize the behavior on each turn, it is preferable to redefined `frame_core`.
  49         # Still, `frame_full` can be redefined with care for more control.
  50         protected fun frame_full
  51         do
  52                 var display = display
  53                 if display != null then frame_core
  54
  55                 feed_events
  56         end
  57
  58         redef fun run
  59         do
  60                 if "NIT_TESTING".environ == "true" then exit 0
  61
  62                 # TODO manage exit condition
  63                 loop frame_full
  64         end
  65
  66         # Loop on available events and feed them back to the app
  67         #
  68         # The implementation varies per platform.
  69         private fun feed_events do end
  70 end