diff options
| author | Olly Mills <[email protected]> | 2021-02-17 01:32:09 +0000 |
|---|---|---|
| committer | Amir Rajan <[email protected]> | 2021-02-17 18:22:39 -0800 |
| commit | cb51bc152392ae8baec4f2584ec0500f7e8a023b (patch) | |
| tree | fe1ce1c21c276ebc01f39455b6e1b04d47be5cd8 | |
| parent | f923bcb6f502cee26b72208499aaa33e0020a0ed (diff) | |
| download | dragonruby-game-toolkit-contrib-cb51bc152392ae8baec4f2584ec0500f7e8a023b.tar.gz dragonruby-game-toolkit-contrib-cb51bc152392ae8baec4f2584ec0500f7e8a023b.zip | |
removed old references to documentation from all sample apps
21 files changed, 3 insertions, 50 deletions
diff --git a/samples/01_rendering_basics/05_sounds/app/main.rb b/samples/01_rendering_basics/05_sounds/app/main.rb index b6d0c3a..28e6503 100644 --- a/samples/01_rendering_basics/05_sounds/app/main.rb +++ b/samples/01_rendering_basics/05_sounds/app/main.rb @@ -19,7 +19,6 @@ - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - reject: Removes elements from a collection if they meet certain requirements. diff --git a/samples/02_input_basics/01_keyboard/app/main.rb b/samples/02_input_basics/01_keyboard/app/main.rb index ee5c8cf..3c5e1b4 100644 --- a/samples/02_input_basics/01_keyboard/app/main.rb +++ b/samples/02_input_basics/01_keyboard/app/main.rb @@ -4,8 +4,7 @@ APIs listing that haven't been encountered in a previous sample apps: - args.inputs.keyboard.key_up.KEY: The value of the properties will be set to the frame that the key_up event occurred (the frame correlates - to args.state.tick_count). Otherwise the value will be nil. For a - full listing of keys, take a look at mygame/documentation/06-keyboard.md. + to args.state.tick_count). Otherwise the value will be nil. - args.state.PROPERTY: The state property on args is a dynamic structure. You can define ANY property here with ANY type of arbitrary nesting. Properties defined on args.state will be retained diff --git a/samples/02_input_basics/05_controller/app/main.rb b/samples/02_input_basics/05_controller/app/main.rb index 99cca15..c986fa9 100644 --- a/samples/02_input_basics/05_controller/app/main.rb +++ b/samples/02_input_basics/05_controller/app/main.rb @@ -7,8 +7,6 @@ If there is more than one controller being used, they can be differentiated by using names like controller_one and controller_two. - For a full listing of buttons, take a look at mygame/documentation/08-controllers.md. - Reminder: - args.state.PROPERTY: The state property on args is a dynamic diff --git a/samples/03_rendering_sprites/01_animation_using_separate_pngs/app/main.rb b/samples/03_rendering_sprites/01_animation_using_separate_pngs/app/main.rb index 80c40f2..c5622e8 100644 --- a/samples/03_rendering_sprites/01_animation_using_separate_pngs/app/main.rb +++ b/samples/03_rendering_sprites/01_animation_using_separate_pngs/app/main.rb @@ -10,15 +10,12 @@ - args.outputs.sprites: An array. Values in this array generate sprites on the screen. The parameters are [X, Y, WIDTH, HEIGHT, IMAGE PATH] - For more information about sprites, go to mygame/documentation/05-sprites.md. - args.outputs.labels: An array. Values in the array generate labels on the screen. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - args.inputs.keyboard.key_down.KEY: Determines if a key is in the down state, or pressed. Stores the frame that key was pressed on. - For more information about the keyboard, go to mygame/documentation/06-keyboard.md. =end diff --git a/samples/03_rendering_sprites/04_color_and_rotation/app/main.rb b/samples/03_rendering_sprites/04_color_and_rotation/app/main.rb index c3f2d8f..072feaf 100644 --- a/samples/03_rendering_sprites/04_color_and_rotation/app/main.rb +++ b/samples/03_rendering_sprites/04_color_and_rotation/app/main.rb @@ -21,14 +21,10 @@ - args.outputs.sprites: An array. The values generate a sprite. The parameters are [X, Y, WIDTH, HEIGHT, PATH, ANGLE, ALPHA, RED, GREEN, BLUE] - Before continuing with this sample app, it is HIGHLY recommended that you look - at mygame/documentation/05-sprites.md. - args.inputs.keyboard.key_held.KEY: Determines if a key is being pressed. - For more information about the keyboard, go to mygame/documentation/06-keyboard.md. - args.inputs.controller_one: Takes input from the controller based on what key is pressed. - For more information about the controller, go to mygame/documentation/08-controllers.md. - num1.lesser(num2): Finds the lower value of the given options. diff --git a/samples/04_physics_and_collisions/02_moving_objects/app/main.rb b/samples/04_physics_and_collisions/02_moving_objects/app/main.rb index 35eabfb..e3e9261 100644 --- a/samples/04_physics_and_collisions/02_moving_objects/app/main.rb +++ b/samples/04_physics_and_collisions/02_moving_objects/app/main.rb @@ -48,13 +48,11 @@ Reminders: - args.inputs.keyboard.KEY: Determines if a key has been pressed. - For more information about the keyboard, take a look at mygame/documentation/06-keyboard.md. - ARRAY#intersect_rect?: Returns true or false depending on if the two rectangles intersect. - args.outputs.solids: An array. The values generate a solid. The parameters are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE] - For more information about solids, go to mygame/documentation/03-solids-and-borders.md. =end diff --git a/samples/04_physics_and_collisions/06_jump_physics/app/main.rb b/samples/04_physics_and_collisions/06_jump_physics/app/main.rb index 3fcb9e9..da01e91 100644 --- a/samples/04_physics_and_collisions/06_jump_physics/app/main.rb +++ b/samples/04_physics_and_collisions/06_jump_physics/app/main.rb @@ -9,7 +9,6 @@ - args.outputs.solids: An array. The values generate a solid. The parameters for a solid are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE] - For more information about solids, go to mygame/documentation/03-solids-and-borders.md. - num1.greater(num2): Returns the greater value. diff --git a/samples/04_physics_and_collisions/07_jump_physics/app/main.rb b/samples/04_physics_and_collisions/07_jump_physics/app/main.rb index 3fcb9e9..da01e91 100644 --- a/samples/04_physics_and_collisions/07_jump_physics/app/main.rb +++ b/samples/04_physics_and_collisions/07_jump_physics/app/main.rb @@ -9,7 +9,6 @@ - args.outputs.solids: An array. The values generate a solid. The parameters for a solid are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE] - For more information about solids, go to mygame/documentation/03-solids-and-borders.md. - num1.greater(num2): Returns the greater value. diff --git a/samples/05_mouse/01_mouse_click/app/main.rb b/samples/05_mouse/01_mouse_click/app/main.rb index 8969a6e..c1a6e29 100644 --- a/samples/05_mouse/01_mouse_click/app/main.rb +++ b/samples/05_mouse/01_mouse_click/app/main.rb @@ -33,11 +33,9 @@ - args.outputs.borders: An array. The values generate a border. The parameters are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE] - For more information about borders, go to mygame/documentation/03-solids-and-borders.md. - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels. =end diff --git a/samples/05_mouse/02_mouse_move/app/main.rb b/samples/05_mouse/02_mouse_move/app/main.rb index 97edbe7..b015277 100644 --- a/samples/05_mouse/02_mouse_move/app/main.rb +++ b/samples/05_mouse/02_mouse_move/app/main.rb @@ -14,11 +14,9 @@ - args.inputs.keyboard.key_down.KEY: Determines if a key is being held or pressed. Stores the frame the "down" event occurred. - For more information about the keyboard, go to mygame/documentation/06-keyboard.md. - args.outputs.sprites: An array. The values generate a sprite. The parameters are [X, Y, WIDTH, HEIGHT, PATH, ANGLE, ALPHA, RED, GREEN, BLUE] - For more information about sprites, go to mygame/documentation/05-sprites.md. - args.state.new_entity: Used when we want to create a new object, like a sprite or button. When we want to create a new object, we can declare it as a new entity and then define diff --git a/samples/05_mouse/03_mouse_move_paint_app/app/main.rb b/samples/05_mouse/03_mouse_move_paint_app/app/main.rb index 9303949..b177fd6 100644 --- a/samples/05_mouse/03_mouse_move_paint_app/app/main.rb +++ b/samples/05_mouse/03_mouse_move_paint_app/app/main.rb @@ -34,7 +34,6 @@ - args.outputs.labels: An array. The values in the array generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGN, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - ARRAY#inside_rect?: Returns true or false depending on if the point is inside the rect. diff --git a/samples/05_mouse/04_coordinate_systems/app/main.rb b/samples/05_mouse/04_coordinate_systems/app/main.rb index fcfa090..8e5578f 100644 --- a/samples/05_mouse/04_coordinate_systems/app/main.rb +++ b/samples/05_mouse/04_coordinate_systems/app/main.rb @@ -5,7 +5,6 @@ - args.inputs.mouse.click.position: Coordinates of the mouse's position on the screen. Unlike args.inputs.mouse.click.point, the mouse does not need to be pressed down for position to know the mouse's coordinates. - For more information about the mouse, go to mygame/documentation/07-mouse.md. Reminders: @@ -21,15 +20,12 @@ - args.outputs.labels: An array that generates a label. The parameters are [X, Y, TEXT, SIZE, ALIGN, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - args.outputs.solids: An array that generates a solid. The parameters are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE, ALPHA] - For more information about solids, go to mygame/documentation/03-solids-and-borders.md. - args.outputs.lines: An array that generates a line. The parameters are [X, Y, X2, Y2, RED, GREEN, BLUE, ALPHA] - For more information about lines, go to mygame/documentation/04-lines.md. =end diff --git a/samples/06_save_load/01_save_load_game/app/main.rb b/samples/06_save_load/01_save_load_game/app/main.rb index 251848a..cc52770 100644 --- a/samples/06_save_load/01_save_load_game/app/main.rb +++ b/samples/06_save_load/01_save_load_game/app/main.rb @@ -36,7 +36,6 @@ - args.outputs.labels: An array. Values generate a label. Parameters are [X, Y, TEXT, SIZE, ALIGN, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information, go to mygame/documentation/02-labels.md. - ARRAY#inside_rect?: An array with at least two values is considered a point. An array with at least four values is considered a rect. The inside_rect? function returns true diff --git a/samples/07_advanced_rendering/03_render_target_viewports/app/main.rb b/samples/07_advanced_rendering/03_render_target_viewports/app/main.rb index dbceab3..b748ffa 100644 --- a/samples/07_advanced_rendering/03_render_target_viewports/app/main.rb +++ b/samples/07_advanced_rendering/03_render_target_viewports/app/main.rb @@ -48,12 +48,10 @@ - ARRAY#intersect_rect?: Returns true or false depending on if the two rectangles intersect. - args.inputs.mouse.click: This property will be set if the mouse was clicked. - For more information about the mouse, go to mygame/documentation/07-mouse.md. - args.inputs.keyboard.key_up.KEY: The value of the properties will be set to the frame that the key_up event occurred (the frame correlates to args.state.tick_count). - For more information about the keyboard, go to mygame/documentation/06-keyboard.md. - args.state.labels: The parameters for a label are @@ -63,7 +61,6 @@ 4. the alignment 5. the color (red, green, and blue saturations) 6. the alpha (or transparency) - For more information about labels, go to mygame/documentation/02-labels.md. - args.state.lines: The parameters for a line are @@ -71,7 +68,6 @@ 2. the ending position (x2, y2) 3. the color (red, green, and blue saturations) 4. the alpha (or transparency) - For more information about lines, go to mygame/documentation/04-lines.md. - args.state.solids (and args.state.borders): The parameters for a solid (or border) are @@ -80,7 +76,6 @@ 3. the height (h) 4. the color (r, g, b) 5. the alpha (or transparency) - For more information about solids and borders, go to mygame/documentation/03-solids-and-borders.md. - args.state.sprites: The parameters for a sprite are @@ -90,7 +85,7 @@ 4. the image path 5. the angle 6. the alpha (or transparency) - For more information about sprites, go to mygame/documentation/05-sprites.md. + =end # This sample app shows different objects that can be used when making games, such as labels, diff --git a/samples/07_advanced_rendering/04_render_primitive_hierarchies/app/main.rb b/samples/07_advanced_rendering/04_render_primitive_hierarchies/app/main.rb index aedd830..7f345ac 100644 --- a/samples/07_advanced_rendering/04_render_primitive_hierarchies/app/main.rb +++ b/samples/07_advanced_rendering/04_render_primitive_hierarchies/app/main.rb @@ -39,7 +39,6 @@ Here is an example of a (red) border or solid definition: [100, 100, 400, 500, 255, 0, 0] It will be a solid or border depending on if it is added to args.outputs.solids or args.outputs.borders. - For more information about solids and borders, go to mygame/documentation/03-solids-and-borders.md. - args.outputs.sprites: An array. The values generate a sprite. The parameters for sprites are @@ -50,7 +49,6 @@ Here is an example of a sprite definition: [100, 100, 400, 500, 'sprites/dragonruby.png'] - For more information about sprites, go to mygame/documentation/05-sprites.md. =end diff --git a/samples/07_advanced_rendering/05_render_primitives_as_hash/app/main.rb b/samples/07_advanced_rendering/05_render_primitives_as_hash/app/main.rb index f7e5bac..53e0f3d 100644 --- a/samples/07_advanced_rendering/05_render_primitives_as_hash/app/main.rb +++ b/samples/07_advanced_rendering/05_render_primitives_as_hash/app/main.rb @@ -16,23 +16,18 @@ - args.outputs.sprites: An array. The values generate a sprite. The parameters are [X, Y, WIDTH, HEIGHT, PATH, ANGLE, ALPHA, RED, GREEN, BLUE] - For more information about sprites, go to mygame/documentation/05-sprites.md. - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - args.outputs.solids: An array. The values generate a solid. The parameters are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE, ALPHA] - For more information about solids, go to mygame/documentation/03-solids-and-borders.md. - args.outputs.borders: An array. The values generate a border. The parameters are the same as a solid. - For more information about borders, go to mygame/documentation/03-solids-and-borders.md. - args.outputs.lines: An array. The values generate a line. The parameters are [X1, Y1, X2, Y2, RED, GREEN, BLUE] - For more information about labels, go to mygame/documentation/02-labels.md. =end diff --git a/samples/09_performance/07_collision_limits/app/main.rb b/samples/09_performance/07_collision_limits/app/main.rb index 01ad308..4a7945c 100644 --- a/samples/09_performance/07_collision_limits/app/main.rb +++ b/samples/09_performance/07_collision_limits/app/main.rb @@ -6,11 +6,9 @@ - args.outputs.solids: An array. The values generate a solid. The parameters are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE] - For more information about solids, go to mygame/documentation/03-solids-and-borders.md. - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - ARRAY#intersect_rect?: Returns true or false depending on if two rectangles intersect. diff --git a/samples/99_genre_dev_tools/tile_editor_starting_point/app/main.rb b/samples/99_genre_dev_tools/tile_editor_starting_point/app/main.rb index 95ccfdf..4238fcd 100644 --- a/samples/99_genre_dev_tools/tile_editor_starting_point/app/main.rb +++ b/samples/99_genre_dev_tools/tile_editor_starting_point/app/main.rb @@ -17,19 +17,15 @@ - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - args.outputs.sprites: An array. The values generate a sprite. The parameters are [X, Y, WIDTH, HEIGHT, IMAGE PATH] - For more information about sprites, go to mygame/documentation/05-sprites.md. - args.outputs.solids: An array. The values generate a solid. The parameters are [X, Y, WIDTH, HEIGHT, RED, GREEN, BLUE] - For more information about solids, go to mygame/documentation/03-solids-and-borders.md. - args.outputs.lines: An array. The values generate a line. The parameters are [X1, Y1, X2, Y2, RED, GREEN, BLUE] - For more information about lines, go to mygame/documentation/04-lines.md. - args.state.new_entity: Used when we want to create a new object, like a sprite or button. In this sample app, new_entity is used to create a new button that clears the grid. diff --git a/samples/99_genre_rpg_narrative/choose_your_own_adventure/app/main.rb b/samples/99_genre_rpg_narrative/choose_your_own_adventure/app/main.rb index 22faad1..9da0f38 100644 --- a/samples/99_genre_rpg_narrative/choose_your_own_adventure/app/main.rb +++ b/samples/99_genre_rpg_narrative/choose_your_own_adventure/app/main.rb @@ -14,10 +14,8 @@ - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. - + - args.keyboard.key_down.KEY: Determines if a key is in the down state or pressed down. - For more information about the keyboard, go to mygame/documentation/06-keyboard.md. - String interpolation: uses #{} syntax; everything between the #{ and the } is evaluated as Ruby code, and the placeholder is replaced with its corresponding value or result. diff --git a/samples/99_genre_rpg_roguelike/roguelike_starting_point/app/main.rb b/samples/99_genre_rpg_roguelike/roguelike_starting_point/app/main.rb index 66ff027..7ed8d60 100644 --- a/samples/99_genre_rpg_roguelike/roguelike_starting_point/app/main.rb +++ b/samples/99_genre_rpg_roguelike/roguelike_starting_point/app/main.rb @@ -9,7 +9,6 @@ Reminders: - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels. - ARRAY#inside_rect?: Returns whether or not the point is inside a rect. diff --git a/samples/99_genre_rpg_topdown/topdown_starting_point/app/main.rb b/samples/99_genre_rpg_topdown/topdown_starting_point/app/main.rb index c447940..33228a6 100644 --- a/samples/99_genre_rpg_topdown/topdown_starting_point/app/main.rb +++ b/samples/99_genre_rpg_topdown/topdown_starting_point/app/main.rb @@ -15,7 +15,6 @@ - args.outputs.labels: An array. The values generate a label. The parameters are [X, Y, TEXT, SIZE, ALIGNMENT, RED, GREEN, BLUE, ALPHA, FONT STYLE] - For more information about labels, go to mygame/documentation/02-labels.md. =end |
