Drag[en]gine Wiki

User Tools

Site Tools

Trace: • abstractions
dragengine:modules:dragonscript:abstractions

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
dragengine:modules:dragonscript:abstractions [2020/05/05 20:36] – dragonlorddragengine:modules:dragonscript:abstractions [2025/03/13 17:03] (current) – dragonlord
Line 4: Line 4:
 </WRAP> </WRAP>
  
- +====== Abstraction Layers: How you want to build your Game ======
-====== Overview ======+
  
 The **DragonScript Scripting Module** provides 3 main ways to build your game depending on your skill level and project requirements. The layers are listed from the most simple one (which is recommended for most projects) to the most flexible one. The **DragonScript Scripting Module** provides 3 main ways to build your game depending on your skill level and project requirements. The layers are listed from the most simple one (which is recommended for most projects) to the most flexible one.
  
 +====== Behavior Elements ======
  
- +<WRAP center round tip 60%> 
-====== Behavior Elements: Quick and Easy Development ======+The Quick and Easy way to Development 
 +</WRAP>
  
 **Behavior Elements** are build on top of the **Scenery Elements** and provide a **composeable** way to build game logic. This is the fastest way to build your game by befitting elements with reusable **behavior** while still retaining all the powerful coupling to other script classes. **Behavior Elements** are build on top of the **Scenery Elements** and provide a **composeable** way to build game logic. This is the fastest way to build your game by befitting elements with reusable **behavior** while still retaining all the powerful coupling to other script classes.
  
-Behavior elements are created by subclassing from [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1BehaviorElementClass.html|BehaviorElementClass]] script class. This class extends the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ElementClass.html|ElementClass]] script class with support to add **Behavior Definitions**. When a [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1BehaviorElement.html|BehaviorElement]] instance is created these **behavior definitions** are used to befit the element with all the required functionality. All this can be done manually by using **Scenery Elements** but using **Behavior Elements** this boils down to just adding the **behavior definitions** you like to use.+[[dragengine:modules:dragonscript:behavior_elements|All about Behavior Elements]]
  
-Behavior definitions are created by subclassing from [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/interfaceDragengine_1_1Scenery_1_1ECBehavior.html|ECBehavior]] script class. This stands for **Element Class Behavior**. Behavior definitions typically contain **Composeable Element Class** or **Element Class Property** instances with appropriate parameters set. This has a few nice properties making life simpler.+====== Scenery Elements ====== 
 +<WRAP center round tip 60%> 
 +Customized and Optimized for Special Needs 
 +</WRAP>
  
-Element class properties can be used with **XML Subclassing**. You can created a new element class just using an XML file (*.deeclass) and change the properties added by the behavior definition. This is especially useful for mappers to add variations of **Game Objects** without needing to touch script code for such a simple task.+TODO
  
-Furthermore **Element Stubs** used to create **Game Objects** in your game world use the same names as the element class properties. This allows mappers to modify behaviors on a per **Game Object** basis if required. +====== Bare-Bone Implementation ====== 
- +<WRAP center round tip 60%> 
-You can query [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1BehaviorElementClass.html|BehaviorElementClass]] if it contains behaviors of a specific type. Some behavior definitions can be used more than once on the same element class. In this case you can assign each instance a unique **identifier**. This identifier is used to distinguish between the behavior definition instances and acts also as prefix modified of the added element class properties. +Create all from Scratch mostly for Framework Creators 
- +</WRAP>
-Once a [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1BehaviorElement.html|BehaviorElement]] instance is created each behavior definitions adds a subclass of [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/interfaceDragengine_1_1Scenery_1_1ECBehaviorInstance.html|ECBehaviorInstance]]. These provide the actual behavior to the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1BehaviorElement.html|BehaviorElement]] instance. Here too you can query the element if it contains instances of a specific behavior. +
- +
-Behaviors are split in two groups: **Basic Behaviors** and **Complex Behaviors**. **Basic Behaviors** add a small basic building block of game logic like for example a component showing the visual appearance of a game object. These are highly reusable. **Complex Behaviors** on the other hand typically expect one or more **Basic Behaviors** to be present in the element class to provide a complex behavior for example animating the visual appearance. +
- +
- +
-The **DragonScript Scripting Module** provides these **Basic Behaviors** as starting help: +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorComponent.html|ECBehaviorComponent]]: Adds a [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1Component.html|Component]] to the providing the **Visual Appearance** of an element. This behavior can be used multiple times. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorCollider.html|ECBehaviorCollider]]: Adds a [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1Collider.html|Collider]] to the element providing the **Physical Interaction** of an element. This contains collision detection of various kinds. This behavior can be used only once. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorLight.html|ECBehaviorLight]]: Attaches a [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1Light.html|Light]] to the element. This behavior can be used multiple times. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorSpeaker.html|ECBehaviorSpeaker]]: Attaches a [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1Speaker.html|Speaker]] to the element. This behavior can be used multiple times. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorTriggered.html|ECBehaviorTriggered]]: Adds support to be triggered by a **Trigger Expression**. This behavior can be used multiple times. +
- +
-The **DragonScript Scripting Module** provides these **Complex Behaviors** as starting help: +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorAnimated.html|ECBehaviorAnimated]]: Adds support to animate a single [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorComponent.html|ECBehaviorComponent]]. This behavior can be used multiple times each instance animating a different [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorComponent.html|ECBehaviorComponent]]. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorTwoStateAnimated.html|ECBehaviorTwoStateAnimated]]: Similar to [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorAnimated.html|ECBehaviorAnimated]] but supports switching between the animation states. A typical example would be a door which can be in an open or closed state.This behavior can be used multiple times. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorMoveOnRail.html|ECBehaviorMoveOnRail]]: Adds support to move an [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorCollider.html|ECBehaviorCollider]] along a path laid out by the mapper using **Rail Corners**. This behavior can be used only once. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorConversation.html|ECBehaviorConversation]]: Adds support to play back a **Conversation** if triggered by [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorTriggered.html|ECBehaviorTriggered]] or manually started. This behavior can be used only once. +
-  * [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1ECBehaviorHearSounds.html|ECBehaviorHearSounds]]: Adds a [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Scenery_1_1SoundLevelMeter.html|SoundLevelMeter]] to listen what sounds are playing around the element. +
- +
- +
-Many more complex behaviors can be created either just for this game project or to be shared with other projects. Behaviors can extend other behaviors by subclassing or by using other behaviors present in the behavior element class. +
- +
-TODO: +
-  * [[behaviors_use_cases|Behaviors Explained: By Use-Case]] +
-  * [[behaviors_a_to_z|Behaviors Explained: From A to Z]] +
- +
-This is an example of an element class which which has a visual appearance, physical interaction, is animated, has two lights, has a speaker and moves along a rail. Basically this describes a kind of train running on a rail between two destinations. +
- +
-<code> +
-pin Dragengine.Gui +
-pin Dragengine.Scenery +
-pin Dragengine.Utils +
- +
-class MyTrainClass extends BehaviorElementClass +
-    public var ECBehaviorComponent component  // visual appearance +
-    public var ECBehaviorAnimated animated  // animated the visual appearance +
-    public var ECBehaviorCollider collider  // physical interaction +
-    public var ECBehaviorMoveOnRail moveOnRail  // move the collider on along a rail +
-    public var ECBehaviorLight headLightLeft  // left head light +
-    public var ECBehaviorLight headLightRight  // right head light +
-    public var ECBehaviorSpeaker speaker  // engine sound +
-     +
-    public func new() super("MyTrainTest") +
-        // create visual appearance with default model(mesh), skin and rig. the rig is used both for +
-        // physical interaction and animation purpose. this method assigns the resources located +
-        // in the common directory "/content/train" +
-        component.setCommonPath("/content/train", "train.demodel", "train.deskin", "train.derig") +
-         +
-        // create collider which is used for physical interaction. in most situations you want to +
-        // animate the component with the rig. this requires to component behavior to go first +
-        collider = ECBehaviorCollider.new(this, component) +
-         +
-        // create head lights. attached to collider with id "headlightLeft" respectively "headlightRight" +
-        headLightLeft = ECBehaviorLight.new(this, collider, "headlightLeft") +
-        headLightLeft.getLight().getColor().setColor(Color.yellow) +
-        headLightLeft.getAttach().getPosition().setVector(Vector.new(-1, 0.5, 2)) +
-         +
-        headLightRight = ECBehaviorLight.new(this, collider, "headlightRight") +
-        headLightRight.getLight().getColor().setColor(Color.yellow) +
-        headLightRight.getAttach().getPosition().setVector(Vector.new(1, 0.5, 2)) +
-         +
-        // create engine speaker. attached to the collider +
-        speaker = ECBehaviorSpeaker.new(this, collider) +
-        speaker.getSpeaker().getSound().setPath("/content/train/engine.ogg") +
-        speaker.getAttach().getPosition().setVector(Vector.new(0.0, 0.5, 1.5)) +
-         +
-        // create behavior animating the visual appearance (component) using an animator +
-        animated = ECBehaviorAnimated.new(this, component) +
-        animated.getAnimator().getAnimator().setPath("/content/train/train.deanimator") +
-         +
-        // create behavior moving collider on rail. the mapper defines what rail to use. +
-        // if you assign also the trigger table from the BaseGameApp then the mapper +
-        // can use triggers to start/stop moving the train. if you want to control this +
-        // on your own (or by other behaviors only) leave out this argument +
-        moveOnRail = ECBehaviorMoveOnRail.new(this, collider, BaseGameApp.getApp().getTriggerTable()) +
-   end +
-end +
-</code> +
- +
-The above script code creates a working element class which adds instances of BehaviorElement to the game world set up with the defined behaviors. If you want to have a unique element instance for your class to work with you can modify the code like this: +
-<code> +
-class MyTrainClass extends BehaviorElementClass +
-    ... +
-    protected func Element createElement() +
-        return MyTrain.new(this) +
-    end +
-end +
- +
-class MyTrain extends BehaviorElement +
-    public func new(MyTrainClass eclass) super(eclass) +
-        ... +
-    end +
-end +
-</code> +
- +
-Using unique instances allows to add run-time features to your class on top of what BehaviorElement provides without creating an own behavior. In general it is recommended to work with behaviors only and creating your own ones. This way you can reuse game logic across different projects easily. +
-====== Scenery Elements: Customized and Optimized for Special Needs ======+
  
 TODO TODO
-====== Bare-Bone Implementation: Create all from Scratch mostly for Framework Creators ====== 
  
-TODO 
dragengine/modules/dragonscript/abstractions.1588710985.txt.gz · Last modified: 2020/05/05 20:36 by dragonlord

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki