 |
XII Release 0.1.0
|
|
XII Release 0.1.0
|
This component is for propagating the flow of power in cables or fluid in pipes and determine whether it arrives at a receiver. More...
#include <PowerConnectorComponent.h>
Public Member Functions | |
| virtual void | SerializeComponent (xiiWorldWriter &inout_stream) const override |
| Override this to save the current state of the component to the given stream. | |
| virtual void | DeserializeComponent (xiiWorldReader &inout_stream) override |
| Override this to load the current state of the component from the given stream. | |
| void | SetOutput (xiiUInt16 value) |
| Sets how much output (of whatever kind) this connector produces. | |
| xiiUInt16 | GetOutput () const |
| void | SetBuddy (xiiGameObjectHandle hObject) |
| void | SetConnectedTo (xiiGameObjectHandle hObject) |
| bool | IsConnected () const |
| Whether the connector is currently connected to another connector. | |
| bool | IsAttached () const |
| Whether the connector is physically attached to another connector. | |
| void | Detach () |
| void | Attach (xiiGameObjectHandle hObject) |
 Public Member Functions inherited from xiiComponent | |
| void | SetActiveFlag (bool bEnabled) |
| Sets the active flag of the component, which affects its active state. | |
| bool | GetActiveFlag () const |
| Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'. | |
| bool | IsActive () const |
| Checks whether this component is in an active state. | |
| bool | IsActiveAndInitialized () const |
| Returns whether this component is active and initialized. | |
| bool | IsActiveAndSimulating () const |
| Whether the component is currently active and simulation has been started as well. | |
| xiiComponentManagerBase * | GetOwningManager () |
| Returns the corresponding manager for this component. | |
| const xiiComponentManagerBase * | GetOwningManager () const |
| Returns the corresponding manager for this component. | |
| xiiGameObject * | GetOwner () |
| Returns the owner game object if the component is attached to one or nullptr. | |
| const xiiGameObject * | GetOwner () const |
| Returns the owner game object if the component is attached to one or nullptr. | |
| xiiWorld * | GetWorld () |
| Returns the corresponding world for this component. | |
| const xiiWorld * | GetWorld () const |
| Returns the corresponding world for this component. | |
| xiiComponentHandle | GetHandle () const |
| Returns a handle to this component. | |
| xiiUInt32 | GetUniqueID () const |
| Returns the unique id for this component. | |
| void | SetUniqueID (xiiUInt32 uiUniqueID) |
| Sets the unique id for this component. | |
| void | EnsureInitialized () |
| Ensures that the component is initialized. Must only be called from another component's Initialize callback. | |
| void | EnsureSimulationStarted () |
| Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback. | |
| XII_ALWAYS_INLINE bool | SendMessage (xiiMessage &ref_msg) |
| Sends a message to this component. | |
| XII_ALWAYS_INLINE bool | SendMessage (xiiMessage &ref_msg) const |
| void | PostMessage (const xiiMessage &msg, xiiTime delay=xiiTime::MakeZero(), xiiObjectMsgQueueType::Enum queueType=xiiObjectMsgQueueType::NextFrame) const |
| Queues the message for the given phase. The message is processed after the given delay in the corresponding phase. | |
| virtual bool | HandlesMessage (const xiiMessage &msg) const |
| Returns whether the given Message is handled by this component. | |
| void | SetUserFlag (xiiUInt8 uiFlagIndex, bool bSet) |
| Be careful to check which flags may already be in use by base classes. | |
| bool | GetUserFlag (xiiUInt8 uiFlagIndex) const |
| Retrieves a custom flag. Index must be between 0 and 7. | |
| void | SetCreatedByPrefab () |
| Adds xiiObjectFlags::CreatedByPrefab to the component. See the flag for details. | |
| bool | WasCreatedByPrefab () const |
| Checks whether the xiiObjectFlags::CreatedByPrefab flag is set on this component. | |
| Public Member Functions inherited from xiiReflectedClass | |
| virtual const xiiRTTI * | GetDynamicRTTI () const |
| bool | IsInstanceOf (const xiiRTTI *pType) const |
| Returns whether the type of this instance is of the given type or derived from it. | |
| template<typename T> | |
| XII_ALWAYS_INLINE bool | IsInstanceOf () const |
| Returns whether the type of this instance is of the given type or derived from it. | |
Protected Member Functions | |
| virtual void | OnDeactivated () override |
| This method is called when the component gets deactivated. | |
| virtual void | OnSimulationStarted () override |
| This method is called once for active components, at the start of the next world update, but only when the world is simulated. | |
| void | SetBuddyReference (const char *szReference) |
| void | SetConnectedToReference (const char *szReference) |
| void | ConnectToSocket (xiiGameObjectHandle hSocket) |
| void | SetInput (xiiUInt16 value) |
| void | OnMsgSensorDetectedObjectsChanged (xiiMsgSensorDetectedObjectsChanged &msg) |
| Whenever a xiiMsgSensorDetectedObjectsChanged arrives, the connector attempts to connect to the reported object. | |
| void | OnMsgObjectGrabbed (xiiMsgObjectGrabbed &msg) |
| Whenever the connector gets grabbed, it detaches from its current connection. | |
| void | InputChanged (xiiUInt16 uiPrevInput, xiiUInt16 uiInput) |
| void | OutputChanged (xiiUInt16 uiOutput) |
| Protected Member Functions inherited from xiiComponent | |
| xiiComponent () | |
| Keep the constructor private or protected in derived classes, so it cannot be called manually. | |
| bool | IsDynamic () const |
| Returns whether this component is dynamic and thus can only be attached to dynamic game objects. | |
| virtual xiiWorldModuleTypeId | GetTypeId () const =0 |
| virtual xiiComponentMode::Enum | GetMode () const =0 |
| virtual void | Initialize () |
| Can be overridden for basic initialization that depends on a valid hierarchy and position. | |
| virtual void | Deinitialize () |
| This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work. | |
| virtual void | OnActivated () |
| This method is called when the component gets activated. | |
| void | EnableUnhandledMessageHandler (bool enable) |
| By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message. | |
| virtual bool | OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) |
| When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. | |
| virtual bool | OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) const |
| When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. | |
| bool | IsInitialized () const |
| bool | IsInitializing () const |
| bool | IsSimulationStarted () const |
Protected Attributes | |
| xiiTime | m_DetachTime |
| xiiGameObjectHandle | m_hAttachPoint |
| xiiGameObjectHandle | m_hGrabbedBy |
| xiiUInt16 | m_uiOutput = 0 |
| xiiUInt16 | m_uiInput = 0 |
| xiiGameObjectHandle | m_hBuddy |
| xiiGameObjectHandle | m_hConnectedTo |
| Protected Attributes inherited from xiiComponent | |
| const xiiRTTI * | m_pMessageDispatchType = nullptr |
| Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from xiiNoBase | |
| static const xiiRTTI * | GetStaticRTTI () |
This component is for propagating the flow of power in cables or fluid in pipes and determine whether it arrives at a receiver.
This component is meant for building puzzles where you have to connect the right objects to power something. It uses physics constraints to physically connect two pieces and have them snap together. It also reacts to being grabbed (xiiMsgObjectGrabbed) to disconnect.
On its own this component doesn't do anything. However, it can be set to be 'connected' to another object with a xiiPowerConnectorComponent, in which case it would propagate its own 'output' as the 'input' on that component. If its output is non-zero and thus the input on the connected component is also non-zero, the other component will post xiiEventMsgSetPowerInput, to which a script can react and for example switch a light on.
Connectors are bi-directional ("full duplex"), so they can have both an input and an output and the two values are independent of each other. That means power can flow in both or just one direction and therefore it is not important with which end a cable gets connected to something.
To enable building things like cables, each xiiPowerConnectorComponent can also have a 'buddy', which is an object on which another xiiPowerConnectorComponent exists. If a connector gets input, that input value is propagated to the buddy as its output value. Thus when a cable gets input on one end, the other end (if it is properly set as the buddy) will output that value. So if that end is also 'connected' to something, the output will be further propagated as the 'input' on that object. This can go through many hops until the value reaches the final connector (if you build a circular chain it will stop when it reaches the starting point).
The component automatically connects to another object when it receives a xiiMsgSensorDetectedObjectsChanged, so it should have a child object with a sensor. The sensor should use a dedicated spatial category to search for markers where it can connect.
To have a sensor (or other effects) only active when the connector is grabbed, put them in a child object with the name "ActiveWhenGrabbed" and disable the object by default. The parent xiiPowerConnectorComponent will toggle the active flag of that object when it gets grabbed or let go.
To build a cable, don't forget to set each end as the 'buddy' of the other end.
|
overridevirtual |
Override this to load the current state of the component from the given stream.
The active state will be automatically serialized. The 'initialized' state is not serialized, all components will be initialized after creation, even if they were already in an initialized state when they were serialized.
Reimplemented from xiiComponent.
|
overrideprotectedvirtual |
This method is called when the component gets deactivated.
Upon destruction, a component that is active first gets deactivated. Therefore OnDeactivated() should be used for typical game code cleanup.
Reimplemented from xiiComponent.
|
protected |
Whenever the connector gets grabbed, it detaches from its current connection.
It also toggles the active flag of the child object with the name "ActiveWhenGrabbed". So to only have it connect to other connectors when grabbed, put the sensor component into such a child object.
|
overrideprotectedvirtual |
This method is called once for active components, at the start of the next world update, but only when the world is simulated.
This is the one preferred method to setup typical game logic. In a pure game environment there is no practical difference between OnActivated() and OnSimulationStarted(), as OnSimulationStarted() will be called right after OnActivated().
However, when a scene is open inside the editor, there is an important difference: OnActivated() is called once the component was created. OnSimulationStarted() is only called once the game simulation is started inside the editor. As an example, if a component starts a sound in OnActivated(), that sound will play right after the scene has been loaded into the editor. If instead the sound gets started in OnSimulationStarted(), it will only play once the user starts the game mode inside the editor.
Additionally, OnSimulationStarted() is only executed once, even if the xiiWorld pauses and resumes world simulation multiple times. However, note that it will be called again after the component has been deactivated and is activated again.
Reimplemented from xiiComponent.
|
overridevirtual |
Override this to save the current state of the component to the given stream.
Reimplemented from xiiComponent.
| void xiiPowerConnectorComponent::SetOutput | ( | xiiUInt16 | value | ) |
Sets how much output (of whatever kind) this connector produces.
If this is zero, it is either a receiver, or a pass-through connector, e.g. a cable, or just currently inactive. If this is non-zero, it acts like a source, and when another connector gets connected to it, that output will be propagated through the connection/buddy chain.
1.13.2