Orx Learning

User Tools

Site Tools

Trace:
en:tutorials:orxscroll:introduction-orxscroll

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:orx:tutorials:community:acksys:scroll0 [2012/05/21 21:16 (12 years ago)] – acksysen:tutorials:orxscroll:introduction-orxscroll [2022/07/14 05:28 (22 months ago)] (current) – [Before You Begin] sausage
Line 1: Line 1:
-======An Introduction to Scroll====== +====== An Introduction to Scroll ====== 
-===What is Scroll?===+===== What is Scroll? =====
  
 Scroll is a small set of C++ files that allow you to use the object-oriented features of C++ when using Orx. Scroll is a small set of C++ files that allow you to use the object-oriented features of C++ when using Orx.
  
-===Features===+===== Features =====
  
   * Scroll supports “object binding” to custom classes. This means when a Scroll Object is created, it can automatically be set to use a C++ of choice for its implementation. This makes it easy to implement behavior that is specific to certain object types.   * Scroll supports “object binding” to custom classes. This means when a Scroll Object is created, it can automatically be set to use a C++ of choice for its implementation. This makes it easy to implement behavior that is specific to certain object types.
   * Additionally, binding object types to classes makes it easy to handle events on an object-specific basis. For example, each type of game object can have its own OnCreate function which is called whenever an object of that type is created.   * Additionally, binding object types to classes makes it easy to handle events on an object-specific basis. For example, each type of game object can have its own OnCreate function which is called whenever an object of that type is created.
-  * Scroll supports saving and loading of .map files for easier Scene management. Scroll includes an embedded Map Editor called ScrollEd.+  * Scroll supports saving and loading of .map files for easier Scene management. Scroll includes an embedded [[en:tutorials:orxscroll:maps-in-scrolled|Map Editor called ScrollEd]].
  
-===Before You Begin=== +{{page>snippets:init_new_orx_scroll_project&nofooter&noeditbutton}}
- +
-This tutorial assumes proficiency with Orx. In particular, you should be comfortable creating a new Orx project as a standalone application.+
  
 You should also be familiar with the concepts of inheritance and polymorphism and how to use them in C++. You should also be familiar with the concepts of inheritance and polymorphism and how to use them in C++.
  
-===Trouble?===+===== Trouble? =====
  
 If you encounter trouble at runtime, check the console log output or debug assertions for error messages. Make sure your Orx config .ini file is loading at runtime and is complete. At a minimum, the config file must define the Display, MainViewport, and MainCamera sections. If you encounter trouble at runtime, check the console log output or debug assertions for error messages. Make sure your Orx config .ini file is loading at runtime and is complete. At a minimum, the config file must define the Display, MainViewport, and MainCamera sections.
Line 22: Line 20:
 If you have any trouble following this tutorial, just ask in the “Help Request” section of the Orx forums. http://orx-project.org/forum If you have any trouble following this tutorial, just ask in the “Help Request” section of the Orx forums. http://orx-project.org/forum
  
-===Getting the Sources===+===== Getting the Sources =====
  
-Getting started with Scroll is easy. iarwain maintains the latest version of Scroll in a Bitbucket repository.+Getting started with Scroll is easy. Scroll is maintained in a [[https://github.com/orx/scroll|GitHub repository]].
  
-If you use the Mercurial version control system, you can pull the latest version of Scroll with this command:+You can clone the latest version of Scroll with this command:
  
-<code>hg clone ssh://hg@bitbucket.org/iarwain/scroll</code>+<code>git clone https://github.com/orx/scroll</code>
  
-Otherwise, you can download the source code directly from Bitbucket here: https://bitbucket.org/iarwain/scroll/src. There is a “get source” button on that page.+Otherwise, you can download the source code directly from GitHub here: https://github.com/orx/scroll/archive/master.zip
  
-===Creating the Project===+===== Creating the Project =====
  
-First, create a new project linking to the SVN Embedded Dynamic version of Orx.+You can find instructions for this here: [[en:tutorials:orxscroll:creating_your_own_scroll_project_using_init|creating a new Orx project]].
  
-Then, extract the Scroll files to their own directory and add that directory to the include path of the Orx project.+Then, extract the Scroll files to their own directory. Add that directory to the include path of the Orx project.
  
-===About the Scroll class===+===== About the Scroll class =====
  
 The Scroll class is the main class in a Scroll project. It is contained in Scroll.h/Scroll.inl. This class is where the game is initialized and the “main loop” runs. You don’t use the Scroll class directly, though. Instead, you create your own class deriving from it. The Scroll class is the main class in a Scroll project. It is contained in Scroll.h/Scroll.inl. This class is where the game is initialized and the “main loop” runs. You don’t use the Scroll class directly, though. Instead, you create your own class deriving from it.
  
-===Deriving from the Scroll class===+===== Deriving from the Scroll class =====
  
 To derive from the Scroll class, first create the interface for the derived class. Add a new header file to the project called OrxScroll.h. Add the following code to it: To derive from the Scroll class, first create the interface for the derived class. Add a new header file to the project called OrxScroll.h. Add the following code to it:
Line 113: Line 111:
 </code> </code>
  
-===Run It===+===== Run It =====
  
 You can now build and run your project. The Init, Run, and Exit functions will work in the normal way and you can apply all your knowledge of Orx in this class. You can now build and run your project. The Init, Run, and Exit functions will work in the normal way and you can apply all your knowledge of Orx in this class.
  
-===What’s the Big Deal?===+===== What’s the Big Deal? =====
  
 This is just the same class as the standalone tutorial, you might be thinking. So far, you’re correct. What we’ve created in this tutorial is the bare minimum running Scroll project. The advantages of Scroll come in all the other functions available in the Scroll classes. Look into the header files to see what is available in the Scroll code; these features will be covered in future tutorials. This is just the same class as the standalone tutorial, you might be thinking. So far, you’re correct. What we’ve created in this tutorial is the bare minimum running Scroll project. The advantages of Scroll come in all the other functions available in the Scroll classes. Look into the header files to see what is available in the Scroll code; these features will be covered in future tutorials.
  
-The next tutorial will introduce object creation (the Scroll way) and object binding.+The [[en:tutorials:orxscroll:binding-orxscroll|next tutorial]] will introduce object creation (the Scroll way) and object binding.
en/tutorials/orxscroll/introduction-orxscroll.txt · Last modified: 2022/07/14 05:28 (22 months ago) by sausage

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC0 1.0 Universal
CC0 1.0 Universal Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki