gale package

gale: a collection of reusable building blocks (state machines, input handling, physics, networking, UI, AI, and more) to speed up building 2D games with pygame. Each submodule (gale.state, gale.input_handler, gale.physics, gale.net, gale.ui, gale.ai, …) is independent — import only the ones a given game actually needs.

Author: Alejandro Mujica (aledrums@gmail.com)

Subpackages

• gale.ai package
  • Submodules
    • gale.ai.agent module
      • Agent
    • gale.ai.behavior_tree module
      • Status
      • Node
      • Action
      • Condition
      • Composite
      • Sequence
      • Selector
      • Parallel
      • Decorator
      • Inverter
      • Succeeder
      • Failer
      • Repeater
      • UntilSuccess
      • UntilFailure
      • Cooldown
      • BehaviorTree
    • gale.ai.blackboard module
      • Blackboard
    • gale.ai.decision_tree module
      • DecisionTreeNode
      • ActionNode
      • DecisionNode
      • RandomDecisionNode
      • DecisionTree
    • gale.ai.graph module
      • CycleError
      • Graph
      • NavGraph
      • DependencyGraph
      • StateGraph
    • gale.ai.minimax module
      • minimax()
      • best_move()
    • gale.ai.perception module
      • has_line_of_sight()
      • VisionCone
      • AlertLevel
      • Perception
    • gale.ai.search module
      • path_cost()
      • depth_first_search()
      • breadth_first_search()
      • dijkstra()
      • a_star()
    • gale.ai.steering module
      • SteeringOutput
      • Kinematic
      • SteeringBehavior
      • Seek
      • Flee
      • Arrive
      • Align
      • Face
      • VelocityMatch
      • Pursue
      • Evade
      • Wander
      • Separation
      • Obstacle
      • ObstacleAvoidance
      • BlendedSteering
      • PrioritySteering
• gale.cutscene package
  • Cutscene
    • Cutscene.update()
    • Cutscene.render()
  • Dialogue
    • Dialogue.render()
  • MoveActor
    • MoveActor.enter()
    • MoveActor.update()
  • PlayAnimation
    • PlayAnimation.enter()
    • PlayAnimation.update()
    • PlayAnimation.render()
    • PlayAnimation.is_complete()
  • SetActorAnimation
    • SetActorAnimation.enter()
    • SetActorAnimation.is_complete()
  • ShowImage
    • ShowImage.render()
  • Wait
  • Submodules
    • gale.cutscene.actions module
      • Wait
      • ShowImage
      • PlayAnimation
      • MoveActor
      • SetActorAnimation
      • Dialogue
    • gale.cutscene.cutscene module
      • Cutscene
• gale.ecs package
  • Submodules
    • gale.ecs.system module
      • System
      • SystemScheduler
    • gale.ecs.world module
      • World
• gale.log package
  • DiscordWebhookHandler
    • DiscordWebhookHandler.emit()
  • GraylogHandler
    • GraylogHandler.emit()
    • GraylogHandler.close()
  • LogLevel
    • LogLevel.DEBUG
    • LogLevel.INFO
    • LogLevel.WARNING
    • LogLevel.ERROR
    • LogLevel.CRITICAL
  • SentryHandler
    • SentryHandler.emit()
  • add_handler()
  • configure()
  • get_logger()
  • remove_handler()
  • Submodules
    • gale.log.config module
      • configure()
      • get_logger()
      • add_handler()
      • remove_handler()
    • gale.log.discord_webhook_handler module
      • DiscordWebhookHandler
    • gale.log.graylog_handler module
      • GraylogHandler
    • gale.log.level module
      • LogLevel
    • gale.log.sentry_handler module
      • SentryHandler
• gale.management package
  • execute_from_command_line()
  • Submodules
    • gale.management.gale_admin module
      • touch()
      • to_pascal_case()
      • to_spaced_name()
      • to_snake_case()
      • execute()
• gale.net package
  • Channel
    • Channel.UNRELIABLE
    • Channel.RELIABLE_ORDERED
    • Channel.RELIABLE_UNORDERED
  • Client
    • Client.on_connect()
    • Client.on_connect_failed()
    • Client.on_disconnect()
    • Client.on_message()
    • Client.connect()
    • Client.get_rtt()
    • Client.send()
    • Client.disconnect()
    • Client.close()
    • Client.update()
  • Peer
    • Peer.update_rtt()
  • PredictionBuffer
    • PredictionBuffer.pending_count
    • PredictionBuffer.record()
    • PredictionBuffer.reconcile()
  • RoomCodeError
  • RoomCodeFormat
    • RoomCodeFormat.alphabet
    • RoomCodeFormat.group_size
    • RoomCodeFormat.group_separator
    • RoomCodeFormat.char_count
  • Server
    • Server.on_connect()
    • Server.on_disconnect()
    • Server.on_message()
    • Server.enable_lan_discovery()
    • Server.get_peers()
    • Server.get_rtt()
    • Server.send_to()
    • Server.broadcast()
    • Server.disconnect()
    • Server.close()
    • Server.update()
  • ServerInfo
    • ServerInfo.name
    • ServerInfo.address
    • ServerInfo.player_count
  • SnapshotInterpolator
    • SnapshotInterpolator.add()
    • SnapshotInterpolator.sample()
  • decode()
  • discover_lan_servers()
  • encode()
  • json_deserialize()
  • json_serialize()
  • lag_compensated_position()
  • Submodules
    • gale.net.channel module
      • ReliableSender
      • ReliableReceiver
    • gale.net.client module
      • Client
    • gale.net.discovery module
      • ServerInfo
      • discover_lan_servers()
    • gale.net.interpolation module
      • SnapshotInterpolator
      • lag_compensated_position()
    • gale.net.peer module
      • Peer
    • gale.net.prediction module
      • PredictionBuffer
    • gale.net.protocol module
      • Channel
      • is_sequence_newer()
      • pack_header()
      • unpack_header()
    • gale.net.room_code module
      • RoomCodeError
      • RoomCodeFormat
      • encode()
      • decode()
    • gale.net.serialization module
      • json_serialize()
      • json_deserialize()
    • gale.net.server module
      • Server
• gale.physics package
  • Body
    • Body.position
    • Body.angle
    • Body.velocity
    • Body.angular_velocity
    • Body.set_velocity()
    • Body.apply_force()
    • Body.apply_torque()
    • Body.apply_impulse()
    • Body.add_circle()
    • Body.add_box()
    • Body.add_polygon()
    • Body.touching_bodies
    • Body.destroy()
  • BodyType
    • BodyType.STATIC
    • BodyType.DYNAMIC
    • BodyType.KINEMATIC
  • BoxShape
  • CircleShape
  • Joint
    • Joint.destroy()
  • Node
    • Node.add_child()
    • Node.remove_child()
    • Node.world_position
    • Node.update()
    • Node.render()
  • PolygonShape
  • RevoluteJoint
    • RevoluteJoint.angle
    • RevoluteJoint.motor_speed
    • RevoluteJoint.max_motor_torque
    • RevoluteJoint.enable_motor
  • WheelJoint
    • WheelJoint.motor_speed
    • WheelJoint.max_motor_torque
    • WheelJoint.enable_motor
    • WheelJoint.frequency
    • WheelJoint.damping_ratio
  • World
    • World.create_static_body()
    • World.create_dynamic_body()
    • World.create_kinematic_body()
    • World.destroy_body()
    • World.create_revolute_joint()
    • World.create_wheel_joint()
    • World.destroy_joint()
    • World.on_collision_begin()
    • World.on_collision_end()
    • World.update()
    • World.fixed_update()
    • World.render_debug()
  • Submodules
    • gale.physics.body module
      • Body
    • gale.physics.body_type module
      • BodyType
    • gale.physics.joint module
      • Joint
      • RevoluteJoint
      • WheelJoint
    • gale.physics.node module
      • Node
    • gale.physics.shapes module
      • CircleShape
      • BoxShape
      • PolygonShape
    • gale.physics.world module
      • World
• gale.tilemap package
  • CollisionType
    • CollisionType.NONE
    • CollisionType.SOLID
    • CollisionType.PLATFORM
  • IsometricTileMap
    • IsometricTileMap.pixel_width
    • IsometricTileMap.pixel_height
    • IsometricTileMap.position_of()
    • IsometricTileMap.tile_at()
    • IsometricTileMap.render()
  • TileMap
    • TileMap.pixel_width
    • TileMap.pixel_height
    • TileMap.add_tileset()
    • TileMap.add_layer()
    • TileMap.layer_names()
    • TileMap.get_layer()
    • TileMap.get_gid()
    • TileMap.set_gid()
    • TileMap.in_bounds()
    • TileMap.tile_at()
    • TileMap.position_of()
    • TileMap.tileset_for_gid()
    • TileMap.properties_of_gid()
    • TileMap.render()
  • TiledLoadError
  • TiledObject
    • TiledObject.name
    • TiledObject.type
    • TiledObject.x
    • TiledObject.y
    • TiledObject.width
    • TiledObject.height
    • TiledObject.properties
  • Tileset
    • Tileset.tile_count
    • Tileset.last_gid
    • Tileset.contains()
    • Tileset.rect_for()
    • Tileset.properties_for()
  • cartesian_to_isometric()
  • collision_type_at()
  • isometric_to_cartesian()
  • load_tiled_map()
  • move_and_collide()
  • Submodules
    • gale.tilemap.collision module
      • CollisionType
      • collision_type_at()
      • move_and_collide()
    • gale.tilemap.isometric module
      • cartesian_to_isometric()
      • isometric_to_cartesian()
      • IsometricTileMap
    • gale.tilemap.tiled_loader module
      • TiledLoadError
      • TiledObject
      • load_tiled_map()
    • gale.tilemap.tilemap module
      • Tileset
      • TileMap
• gale.ui package
  • Button
    • Button.render()
    • Button.on_mouse_click()
    • Button.on_confirm()
  • Checkbox
    • Checkbox.toggle()
    • Checkbox.render()
    • Checkbox.on_mouse_click()
    • Checkbox.on_confirm()
  • Container
    • Container.focusable
    • Container.add_child()
    • Container.remove_child()
    • Container.update()
    • Container.render()
    • Container.on_mouse_motion()
    • Container.on_mouse_click()
    • Container.on_confirm()
    • Container.on_navigate()
  • Cursor
    • Cursor.set_as_system_cursor()
    • Cursor.show()
    • Cursor.hide()
    • Cursor.render()
  • Label
    • Label.set_text()
    • Label.render()
  • ListView
    • ListView.row_height()
    • ListView.row_rect()
    • ListView.render()
    • ListView.on_mouse_motion()
    • ListView.on_mouse_click()
    • ListView.on_confirm()
    • ListView.on_navigate()
  • PaginatedTextBox
    • PaginatedTextBox.update()
  • Panel
    • Panel.render()
  • ProgressBar
    • ProgressBar.render()
  • Theme
  • TextBox
    • TextBox.finished
    • TextBox.page_count
    • TextBox.has_next_page
    • TextBox.has_previous_page
    • TextBox.advance()
    • TextBox.next_page()
    • TextBox.previous_page()
    • TextBox.render()
    • TextBox.on_mouse_click()
    • TextBox.on_confirm()
  • TextInput
    • TextInput.handle_key()
    • TextInput.render()
    • TextInput.on_mouse_click()
  • UIManager
    • UIManager.update()
    • UIManager.render()
    • UIManager.on_input()
  • Widget
    • Widget.focusable
    • Widget.theme
    • Widget.rect
    • Widget.contains()
    • Widget.update()
    • Widget.render()
    • Widget.on_mouse_motion()
    • Widget.on_mouse_click()
    • Widget.on_confirm()
    • Widget.on_navigate()
  • Window
    • Window.close()
  • get_default_theme()
  • set_default_theme()
  • Submodules
    • gale.ui.button module
      • Button
    • gale.ui.checkbox module
      • Checkbox
    • gale.ui.container module
      • Container
    • gale.ui.cursor module
      • Cursor
    • gale.ui.label module
      • Label
    • gale.ui.list_view module
      • ListView
    • gale.ui.manager module
      • UIManager
    • gale.ui.panel module
      • Panel
    • gale.ui.progress_bar module
      • ProgressBar
    • gale.ui.text_box module
      • TextBox
      • PaginatedTextBox
    • gale.ui.text_input module
      • TextInput
    • gale.ui.theme module
      • Theme
      • get_default_theme()
      • set_default_theme()
    • gale.ui.widget module
      • Widget
    • gale.ui.window module
      • Window

Submodules

• gale.animation module
  • Animation
    • Animation.reset()
    • Animation.update()
    • Animation.get_current_frame()
• gale.camera module
  • Camera
    • Camera.follow()
    • Camera.unfollow()
    • Camera.shake()
    • Camera.update()
    • Camera.offset
    • Camera.world_to_screen()
    • Camera.screen_to_world()
    • Camera.apply()
• gale.ease_functions module
  • ease_linear()
  • ease_in_sine()
  • ease_out_sine()
  • ease_in_out_sine()
  • ease_in_quad()
  • ease_out_quad()
  • ease_in_out_quad()
  • ease_in_cubic()
  • ease_out_cubic()
  • ease_in_out_cubic()
  • ease_in_quart()
  • ease_out_quart()
  • ease_in_out_quart()
  • ease_in_quint()
  • ease_out_quint()
  • ease_in_out_quint()
  • ease_in_expo()
  • ease_out_expo()
  • ease_in_out_expo()
  • ease_in_circ()
  • ease_out_circ()
  • ease_in_out_circ()
  • ease_in_back()
  • ease_out_back()
  • ease_in_out_back()
  • ease_in_elastic()
  • ease_out_elastic()
  • ease_in_out_elastic()
  • ease_in_bounce()
  • ease_out_bounce()
  • ease_in_out_bounce()
• gale.factory module
  • Factory
    • Factory.create()
  • AbstractFactory
    • AbstractFactory.get_factory()
• gale.frames module
  • generate_frames()
• gale.game module
  • Game
    • Game.init()
    • Game.on_input()
    • Game.update()
    • Game.render()
    • Game.exec()
    • Game.quit()
• gale.input_handler module
  • InvalidListenerException
  • KeyboardData
    • KeyboardData.get_action_key()
    • KeyboardData.get_action_name()
  • MouseClickData
    • MouseClickData.get_action_key()
    • MouseClickData.get_action_name()
  • MouseWheelData
    • MouseWheelData.get_action_key()
    • MouseWheelData.get_action_name()
  • MouseMotionData
    • MouseMotionData.get_action_key()
    • MouseMotionData.get_action_name()
  • GamepadButtonData
    • GamepadButtonData.get_action_key()
    • GamepadButtonData.get_action_name()
  • GamepadAxisData
    • GamepadAxisData.get_action_key()
    • GamepadAxisData.get_action_name()
  • InputListener
    • InputListener.on_input()
  • apply_deadzone()
  • InputHandler
    • InputHandler.INPUT_DATA_TABLE
    • InputHandler.input_binding
    • InputHandler.gamepads
    • InputHandler.listeners
    • InputHandler.init_gamepads()
    • InputHandler.register_listener()
    • InputHandler.unregister_listener()
    • InputHandler.notify()
    • InputHandler.set_keyboard_action()
    • InputHandler.set_mouse_click_action()
    • InputHandler.set_mouse_wheel_action()
    • InputHandler.set_mouse_motion_action()
    • InputHandler.set_gamepad_button_action()
    • InputHandler.set_gamepad_axis_action()
    • InputHandler.handle_input()
• gale.math_util module
  • real_equal()
• gale.particle_system module
  • Particle
    • Particle.update()
    • Particle.render()
  • ParticleSystem
    • ParticleSystem.set_life_time()
    • ParticleSystem.set_linear_acceleration()
    • ParticleSystem.set_colors()
    • ParticleSystem.set_area_spread()
    • ParticleSystem.generate()
    • ParticleSystem.update()
    • ParticleSystem.render()
• gale.quest module
  • Objective
    • Objective.notify()
    • Objective.is_complete()
  • Stage
    • Stage.notify()
  • Quest
    • Quest.notify()
    • Quest.current_stage
  • QuestLog
    • QuestLog.register()
    • QuestLog.start()
    • QuestLog.get()
    • QuestLog.is_active()
    • QuestLog.is_completed()
    • QuestLog.active_quests()
    • QuestLog.notify()
    • QuestLog.update()
    • QuestLog.on_input()
• gale.sequence module
  • Step
    • Step.enter()
    • Step.exit()
    • Step.update()
    • Step.render()
    • Step.on_input()
    • Step.is_complete()
  • StepGroup
    • StepGroup.enter()
    • StepGroup.exit()
    • StepGroup.update()
    • StepGroup.render()
    • StepGroup.on_input()
    • StepGroup.is_complete()
  • Sequence
    • Sequence.update()
    • Sequence.render()
    • Sequence.on_input()
    • Sequence.skip_current()
• gale.state module
  • BaseState
    • BaseState.enter()
    • BaseState.exit()
    • BaseState.on_input()
    • BaseState.update()
    • BaseState.render()
  • StateMachine
    • StateMachine.change()
    • StateMachine.on_input()
    • StateMachine.update()
    • StateMachine.render()
  • HierarchicalState
    • HierarchicalState.enter()
    • HierarchicalState.change_substate()
    • HierarchicalState.on_input()
    • HierarchicalState.update()
    • HierarchicalState.render()
  • StateStack
    • StateStack.on_input()
    • StateStack.update()
    • StateStack.render()
    • StateStack.clear()
    • StateStack.push()
    • StateStack.pop()
• gale.stencil module
  • Stencil
    • Stencil.clear()
    • Stencil.draw()
    • Stencil.apply()
• gale.text module
  • render_text()
  • Text
    • Text.render()
• gale.timer module
  • TimerItemBase
    • TimerItemBase.finish()
    • TimerItemBase.remove()
  • Every
    • Every.update()
  • After
    • After.update()
  • Tween
    • Tween.update()
  • Timer
    • Timer.items
    • Timer.paused
    • Timer.update()
    • Timer.every()
    • Timer.after()
    • Timer.tween()
    • Timer.clear()
    • Timer.pause()
    • Timer.resume()