Differences

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

--- dragengine:modules:dragonscript:behavior_playerinteractprompt [2024/03/14 16:56] – dragonlord
+++ dragengine:modules:dragonscript:behavior_playerinteractprompt [2025/03/13 17:15] (current) – dragonlord
@@ Line 1: / Line 1: @@
 {{tag>dragonscript behavior}}
 <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorPlayerAtInteractPrompt**
+[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[dragengine:modules:dragonscript:abstractions|Abstraction Layers: How you want to build your Game]] >> [[dragengine:modules:dragonscript:behavior_elements|Behavior Elements]] >> **ECBehaviorPlayerAtInteractPrompt**
 </WRAP>
@@ Line 27: / Line 27: @@
 It is possible to temporarily disabled this behavior. This allows to hide interact prompts for example if the player is performing an action where he is not able to interact with anything, for example being in a conversation or playing a cutscene.
+See [[#element_class_example|Element Class Example]] for example code of a prompt controller.
 This behavior is used for player actors only.
@@ Line 32: / Line 34: @@
 ===== Prompt Widget =====
-To display the prompt a prompt widget is required. This widget is created at the appropriate time by the behavior. For this to work you have to assign a //Prompt Controller Factory// while adding the behavior. The //Prompt Controller Factory// is an interface knowing how to create an instance of a //Prompt Controller//. The //Prompt Controller// itself knows how to create the prompt widget, how to update the widget to reflect the visible prompts as well as how to apply transparency and visibility changes.
+To display the prompt a prompt widget is required. This widget is created at the appropriate time by the behavior. For this to work you have to assign a ''Prompt Controller Factory'' while adding the behavior. The ''Prompt Controller Factory'' is an interface knowing how to create an instance of a ''Prompt Controller''. The ''Prompt Controller'' itself knows how to create the prompt widget, how to update the widget to reflect the visible prompts as well as how to apply transparency and visibility changes.
-The //PanelInteractPromptController// is the default prompt controller provided by the DragonScript module. It creates and manages an instance of //PanelInteractPrompt// which shows a horizontal list of prompts centered in the middle of the parent container. By subclassing //PanelInteractPromptController// you can change what promtp widget is created. This is an example of such a prompt controller:
+The ''PanelInteractPromptController'' is the default prompt controller provided by the DragonScript module. It creates and manages an instance of ''PanelInteractPrompt'' which shows a horizontal list of prompts centered in the middle of the parent container. By subclassing ''PanelInteractPromptController'' you can change what prompt widget is created.
-<code>
-// create prompt controller based on PanelInteractPromptController. this is the
-// fastest way to get started. otherwise you can implement
-// ECBehaviorPlayerInteractPrompt.PromptController to customize everything
-class CustomPromptController extends PanelInteractPromptController
-  // factory creating instances of CustomPromptController
-  class ControllerFactory implements ECBehaviorPlayerInteractPrompt.PromptControllerFactory
-    // create instance of prompt controller
-    public func new()
-    end
-    // create prompt controller
-    public func ECBehaviorPlayerInteractPrompt.PromptController \
-    createPromptController(ECBehaviorPlayerInteractPrompt.Instance instance)
-      return CustomPromptController.new(instance.getECBehavior().getBindingManager(), instance.getBindingIconHeight())
-    end
-  end
-  // create prompt controller instance
-  public func new(BindingManager bindingManager, int bindingIconHeight) super(bindingManager, bindingIconHeight)
-  end
-  // create prompt widget. place the prompts in the lower right corner of the screen.
-  protected func void createContent(PanelInteractPrompt panelInteractPrompt)
-    super.createContent(PanelInteractPrompt panelInteractPrompt)
-    // the two numbers indicate the relative placement of the centrized box.
-    // the first number is the X axis and the second the Y axis. both values
-    // are one which means at the right edge and at the bottom edge.
-    setLayout(CentrizedBoxLayout.new(LayoutAxis.x, 1, 1)
-  end
-end
-</code>
 ===== Container Widget =====
-You have to specify where the prompt controller created prompt widget has to be shown in. Requires a //Container// instance with an optional layout settings instance. Layout settings instances are only required for certain layouts like BorderLayout. In general this can be null.
+You have to specify where the prompt controller created prompt widget has to be shown in. Requires a ''Container'' instance with an optional layout settings instance. Layout settings instances are only required for certain layouts like BorderLayout. In general this can be null.
-//BaseGameApp.getApp().getWindowGameWorld()// is suitable as container UI since it uses StackLayout which works well with PanelInteractPrompt. You can though use any subclass of //Container// as long as you can provide the container instances early enough.
+''BaseGameApp.getApp().getWindowGameWorld()'' is suitable as container UI since it uses StackLayout which works well with PanelInteractPrompt. You can though use any subclass of ''Container'' as long as you can provide the container instances early enough.
+===== Behavior Factory =====
+The behavior factory script class is an abstract class. To use this behavior create a factory subclass and implement these functions:
+^Function^Description^
+|createPromptControllerFactory|Create prompt controller factory.|
+|getUiContainer|Get UI container.|
+|getUiContainerAddSettings|Get UI container add settings.|
+This is required since these functions are so game specific that no sane default value can be provided.
 ====== Instance Counts ======
-This behavior can be used only once on an element. The behavior always has identifier //empty string//.
+This behavior can be used only once on an element.
 ====== Element Class Properties ======
-Element class properties have the prefix **playerInteractPrompt.**.
+Element class properties have the prefix ''playerInteractPrompt.''.
 ===== bindingIconHeight =====
-Size in pixels to use for bindings to display. This is used to pick from the //Input Module// the device button or axis display image with the best matching size.
-  * Full name: "interactPrompt.bindingIconHeight"
+Size in pixels to use for bindings to display. This is used to pick from the ''Input Module'' the device button or axis display image with the best matching size.
-  * Type integer
-  * Minimum Value 1
+  * Full name: ''interactPrompt.bindingIconHeight''
-  * Default Value 32
+  * Type: integer
-  * Example (*.deeclass) <code xml><integer name='interactPrompt.bindingIconHeight'>32</integer></code>
+  * Default Value: ''32''
+  * Restrictions: At least ''1''
+  * Example (*.deeclass): <code xml><integer name='interactPrompt.bindingIconHeight'>32</integer></code>
 ===== transparency =====
 Transparency of the prompt widget. The used prompt controller decides how the transparency is applied. The default prompt widget applies the transparency to the panel containing all displayed prompts.
-  * Full name: "interactPrompt.transparency"
-  * Type integer
+  * Full name: ''interactPrompt.transparency''
-  * Minimum Value 0
+  * Type: integer
-  * Maximum Value 1
+  * Default Value: ''1''
-  * Default Value 1
+  * Restrictions: At least ''0'' and at most ''1''
-  * Example (*.deeclass) <code xml><float name='interactPrompt.transparency'>0.75</float></code>
+  * Example (*.deeclass): <code xml><float name='interactPrompt.transparency'>0.75</float></code>
+===== visibleIfEmpty =====
+Show prompt widget if no prompts are present.
+  * Full name: ''interactPrompt.visibleIfEmpty''
+  * Type: boolean
+  * Default Value: ''false''
+  * Example (*.deeclass): <code xml><boolean name='interactPrompt.visibleIfEmpty'>true</boolean></code>
+====== Events ======
+This behavior has no events.
+===== acceptInteractPrompt =====
+Accept interact prompt to be shown. If all listeners return true the prompt is accepted otherwise rejected.
 ====== Required Behaviors ======
   * [[behavior_playercontrollable|ECBehaviorPlayerControllable]]
 ====== Optional Behaviors ======
 This behavior does not support optional behaviors.
 ====== Persistency ======
-This behavior does not use persistency.
+This behavior does not required element class to be persistable (setPersistable).
 ====== API Documentation ======
 #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorInteractPrompt.html,ECBehaviorInteractPrompt~@#.
-Since DragonScript Module Version **1.2**
+Since DragonScript Module Version ''1.2''
 ====== Use Cases ======
   * Show situation dependend interactions the player can do. This can be for example a sitting player shown how he can get up or an energy bar filled up and the player can now do a special attack. Requires the player to use ECBehaviorInteractPrompt enabled/disabled depending in the situation and ECBehaviorPlayerInteractPrompt to show the prompts.
@@ Line 151: / Line 154: @@
 end
 </code>
+Example of a prompt controller:
+<code>
+// create prompt controller based on PanelInteractPromptController. this is the
+// fastest way to get started. otherwise you can implement
+// ECBehaviorPlayerInteractPrompt.PromptController to customize everything
+class CustomPromptController extends PanelInteractPromptController
+  // factory creating instances of CustomPromptController
+  class ControllerFactory implements ECBehaviorPlayerInteractPrompt.PromptControllerFactory
+    // create instance of prompt controller
+    public func new()
+    end
+    // create prompt controller
+    public func ECBehaviorPlayerInteractPrompt.PromptController \
+    createPromptController(ECBehaviorPlayerInteractPrompt.Instance instance)
+      return CustomPromptController.new(instance.getECBehavior().getBindingManager(), instance.getBindingIconHeight())
+    end
+  end
+  // create prompt controller instance
+  public func new(BindingManager bindingManager, int bindingIconHeight) super(bindingManager, bindingIconHeight)
+  end
+  // create prompt widget. place the prompts in the lower right corner of the screen.
+  protected func void createContent(PanelInteractPrompt panelInteractPrompt)
+    super.createContent(PanelInteractPrompt panelInteractPrompt)
+    // the two numbers indicate the relative placement of the centrized box.
+    // the first number is the X axis and the second the Y axis. both values
+    // are one which means at the right edge and at the bottom edge.
+    setLayout(CentrizedBoxLayout.new(LayoutAxis.x, 1, 1)
+  end
+end
+</code>
+====== Behavior Factory ======
+Using element class supporting adding behaviors the behavior can be added like this:
+<code xml>
+<?xml version='1.0' encoding='UTF-8'?>
+<elementClass name='MyClass' class='GenericBehaviorElement'>
+  <behavior type='ECBehaviorPlayerInteractPrompt'>
+    <!-- optional: use BaseGameApp command manager. game can add more supported values.
+                   default is 'default' -->
+    <string name='commandManager'>default</string>
+    <!-- optional: use BaseGameApp binding manager. game can add more supported values.
+                   default is 'default' -->
+    <string name='bindingManager'>default</string>
+    <!-- set element properties. omit property prefix if used inside behavior tag -->
+    <integer name='.bindingIconHeight'>32</integer>
+  </behavior>
+</elementClass>
+</code>
+====== Live Examples ======
+  * [[https://github.com/LordOfDragons/deexamples|DEExamples Repository]]

Drag[en]gine Wiki

User Tools

Site Tools

Differences

Page Tools