Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent Class Reference
Behavior tree action sending a global event. More...
Inheritance diagram for Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent:
Public Member Functions | |
| Object | getData () |
| Optional parameter to send with event. More... | |
| String | getEvent () |
| Event to send. More... | |
| GlobalEvents | getGlobalEvents () |
| Global event instance to send event to. More... | |
| Object | getSource () |
| Optional source of event. More... | |
| BTActionSendGlobalEvent | new (GlobalEvents globalEvents, String event) |
| Create action. More... | |
| BTActionSendGlobalEvent | new (GlobalEvents globalEvents, String event, Object source, Object data) |
| Create action. More... | |
| BTActionSendGlobalEvent | new (String event) |
| Create action using BaseGameApp global events. More... | |
| BTActionSendGlobalEvent | new (String event, Object source, Object data) |
| Create action using BaseGameApp global events. More... | |
| BTResult | runAction (BTContext context, Dictionary parameters) |
| Run action. More... | |
| void | setData (Object data) |
| Set optional parameter to send with event. More... | |
| void | setEvent (String event) |
| Set event to send. More... | |
| void | setGlobalEvents (GlobalEvents globalEvents) |
| Set global event instance to send event to. More... | |
| void | setSource (Object source) |
| Set optional source of event. More... | |
Public Attributes | |
| Object | pData |
| String | pEvent |
| GlobalEvents | pGlobalEvents |
| Object | pSource |
Detailed Description
Behavior tree action sending a global event.
This action always returns BTResult.success.
Member Function Documentation
◆ getData()
| Object Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.getData | ( | ) |
Optional parameter to send with event.
◆ getEvent()
| String Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.getEvent | ( | ) |
Event to send.
◆ getGlobalEvents()
| GlobalEvents Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.getGlobalEvents | ( | ) |
Global event instance to send event to.
◆ getSource()
| Object Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.getSource | ( | ) |
Optional source of event.
◆ new() [1/4]
| BTActionSendGlobalEvent Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.new | ( | GlobalEvents | globalEvents, |
| String | event | ||
| ) |
Create action.
◆ new() [2/4]
| BTActionSendGlobalEvent Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.new | ( | GlobalEvents | globalEvents, |
| String | event, | ||
| Object | source, | ||
| Object | data | ||
| ) |
Create action.
◆ new() [3/4]
| BTActionSendGlobalEvent Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.new | ( | String | event | ) |
Create action using BaseGameApp global events.
◆ new() [4/4]
| BTActionSendGlobalEvent Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.new | ( | String | event, |
| Object | source, | ||
| Object | data | ||
| ) |
Create action using BaseGameApp global events.
◆ runAction()
| BTResult Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.runAction | ( | BTContext | context, |
| Dictionary | parameters | ||
| ) |
Run action.
- Parameters
-
parameters Dictionary with parameters of type String key and String value. Do not change the content of the dictionary as it is shared.
Implements Dragengine.BehaviorTreeSystem.BTAction.
◆ setData()
| void Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.setData | ( | Object | data | ) |
Set optional parameter to send with event.
◆ setEvent()
| void Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.setEvent | ( | String | event | ) |
Set event to send.
◆ setGlobalEvents()
| void Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.setGlobalEvents | ( | GlobalEvents | globalEvents | ) |
Set global event instance to send event to.
◆ setSource()
| void Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.setSource | ( | Object | source | ) |
Set optional source of event.
Member Data Documentation
◆ pData
| Object Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.pData |
◆ pEvent
| String Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.pEvent |
◆ pGlobalEvents
| GlobalEvents Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.pGlobalEvents |
◆ pSource
| Object Dragengine.BehaviorTreeSystem.BTActionSendGlobalEvent.pSource |
The documentation for this class was generated from the following file:
