DragonRuby API Docs

This content is generate from the original DragonRuby docs, but contains just the core API documentation with a few bells and whistles like sticky headers and syntax highlighting.

RECIPIES:

• How To Determine What Frame You Are On
• How To Get Current Framerate
• How To Render A Sprite Using An Array
• More Sprite Properties As An Array
• Different Sprite Representations
• How To Render A Label
• A Colored Label
• Extended Label Properties
• Rendering A Label As A Hash
• Getting The Size Of A Piece Of Text
• Rendering Labels With New Line Characters And Wrapping
• How To Play A Sound
• Using args.state To Store Your Game State
• Accessing files
• Troubleshoot Performance

Runtime

• Indie and Pro Functions
• Environment and Utility Functions
• File IO Functions
• XML and JSON
• Network IO Functions
• Developer Support Functions

args.state

• args.state.*.entity_id
• args.state.*.entity_type
• args.state.*.created_at
• args.state.*.created_at_elapsed
• args.state.*.global_created_at
• args.state.*.global_created_at_elapsed
• args.state.*.as_hash
• args.state.new_entity
• args.state.new_entity_strict
• args.state.tick_count
• args.events.resize_occured

args.inputs

• args.inputs.last_active
• args.inputs.locale
• args.inputs.up
• args.inputs.down
• args.inputs.left
• args.inputs.right
• args.inputs.left_right
• args.inputs.up_down
• args.inputs.text OR args.inputs.history
• args.inputs.mouse
• args.inputs.controller_(one-four)
• args.inputs.controller_(one-four).active
• args.inputs.keyboard
• args.inputs.keyboard.active
• args.inputs.touch
• args.inputs.finger_left
• args.inputs.finger_right

args.outputs

• args.outputs.background_color
• args.outputs.sounds
• args.outputs.solids
• args.outputs.static_solids
• args.outputs.sprites , .static_sprites
• args.outputs.primitives , .static_primitives
• args.outputs.labels , .static_labels
• args.outputs.lines , .static_lines
• args.outputs.borders , .static_borders
• args.outputs.debug , .static_debug

args.easing

• args.easing.ease start_tick, current_tick, duration, easing_functions
• args.easing.ease_spline start_tick, current_tick, duration, spline

args.string

• args.string.wrapped_lines string, max_character_length

args.grid

• args.grid.name
• args.grid.bottom
• args.grid.top
• args.grid.left
• args.grid.right
• args.grid.rect
• args.grid.origin_bottom_left!
• args.grid.origin_center!
• args.grid.w
• args.grid.h

Geometry

• intersect_rect?
• inside_rect?
• scale_rect
• scale_rect_extended
• anchor_rect
• angle_from
• angle_to
• distance
• point_inside_circle?
• center_inside_rect
• ray_test
• line_rise_run
• rotate_point
• find_intersect_rect
• find_all_intersect_rect
• find_intersect_rect_quad_tree
• create_quad_tree

args.audio

• One-Time Sounds
• Looping Audio
• Setting Additional Audio Properties
• Advanced Audio Manipulate (Crossfade)
• Audio encoding trouble shooting
• Audio synthesis

args.easing

• Example
• Easing Definitions

Pixel Arrays

• Related Sample Apps

args.cvars

Outputs

• Render Order

Solids

• Rendering a solid using an Array
• Rendering a solid using an Array with colors and alpha
• Rendering a solid using a Hash
• Rendering a solid using a Class

Borders

Sprites

• Rendering a sprite using an Array
• Rendering a sprite using an Array with colors and alpha
• Rendering a sprite using a Hash
• Rendering a solid using a Class

Labels

• Rendering a label using an Array
• Rendering a label using a Hash

Screenshots

• Chroma key (Making a color transparent)

Mouse

OpenEntity

• as_hash

Array

• map_2d
• include_any?
• any_intersect_rect?
• map
• each
• reject_nil
• reject_false
• product

Numeric

• frame_index
• elapsed_time
• elapsed?
• new?

Kernel

• tick_count
• global_tick_count