Subscribe to download
Remote Rope Control Component

This is for modders. It adds an easy to use component that allows you to recieve keybinding controls when the user is connected.

You can look at an example block that uses it in the Balloons mod. Search for the LockingPin.sbc and PAX_LockPin script

How to use:

Your block needs the following for this to work: UseObjectsComponent, ModelAttachmentComponent, EntityRopeComponent, RemoteRopeControlComponent.
And also your Control definitions

UseObjectsComponent:
Add <UseObject Dummy="detector_remoterope" Name="Generic" />
your model also needs the detector

ModelAttachmentComponent:
Add attachment with name: RemoteRopeControlComponent_sub
The model you can use is: Models\RemoteRopeControlComponent_sub.mwm
You can also use your own dummy rope model. The visual rope connection is optional

EntityRopeComponent:
This sets the visual rope connection, you can use any number of ropes. example:
<Connection From="RemoteRopeControlComponent_sub:detector_fakerope" To="detector_fakerope">
<RopeDefinition Type="RopeDefinition" Subtype="BasicRope" />
</Connection>
You can use your own detector names, added to the subpart model and the main model

Now the importart part, the RemoteRopeControlComponent

the channels:

<Channels>
<KeybindingChannel>
<ControlDefinitions>
<ControlDefinition>
<ControlDefinitionName>ControlDefinitionName</ControlDefinitionName>
<InputState>Pressed</InputState>
</ControlDefinition>
</ControlDefinitions>
</KeybindingChannel>
</Channels>

You can add any number of channels, and each channel can have any number of keys. You enter the name of the control definition and the input state (Pressed, Down, Up, Released, Any)

variants:

<VariantsSubTypeId>
<Variant>BlockB</Variant>
<Variant>BlockC</Variant>
</VariantsSubTypeId>

If you have one or more block variants that you want able to be connected, put them here. This is optional

<MaxRange>50</MaxRange> -> this is the distance at which the connection will be disconnected
<Inverted>false</Inverted> -> this will invert the first 2 keys added to a channel

Control definition example:

<Definition xsi:type="MyObjectBuilder_ControlDefinition">
<Id Type="MyObjectBuilder_ControlDefinition" Subtype="TheNameYouEnterInTheComponent" />
<DisplayName>Channel X - DoStuffOnKeyPress</DisplayName>
<Category>RemoteRopeCategory</Category>
<Primary Key="Y" />
</Definition>

the RemoteRopeCategory has been added to this mod. You can use it if you don't want your own category or don't want to use vanilla ones


YOUR SCRIPT:

The component will send events of the pressed keys.
To subscribe to these you must find the MyRemoteRopeControlComponent in your block container and subscribe to the OnControlRecieved event. The event will send a short variable containing the key number that was pressed and a short variable containing the current channel.

the MyRemoteRopeControlComponent is found in the Pax.RemoteRope namespace

If you need any custom behaviour, feel free to copy the code to your own mod, or ask me to add it to the component.