Skip to content

class_watercraftrudder

jonri edited this page Oct 28, 2023 · 7 revisions

This file is automatically generated. To make changes, please edit the corresponding xml file in the doc_classes/ folder instead.

WatercraftRudder

Inherits:

Adds a steerable rudder to a HydroRigidBody.

.. rst-class:: classref-introduction-group

Description

This will generate a rudder of a given size and calculate the forces along with the rest of the hull. As with the rest of the hull, only the submerged portion of the rudder will function.

.. rst-class:: classref-reftable-group

Properties

.. rst-class:: classref-section-separator


.. rst-class:: classref-descriptions-group

Property Descriptions

.. rst-class:: classref-property

float depth = 1.0

.. rst-class:: classref-property-setget

  • void set_depth ( float value )
  • float get_depth ( )

The extent of the rudder below the origin.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

Vector3 direction = Vector3(0, 0, 0)

.. rst-class:: classref-property-setget

  • void set_direction ( Vector3 value )
  • Vector3 get_direction ( )

The direction the rudder will face. Change the direction to steer the rudder.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

float length = 1.0

.. rst-class:: classref-property-setget

  • void set_length ( float value )
  • float get_length ( )

The length of the rudder in the specified direction.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

Vector3 origin = Vector3(0, 0, 0)

.. rst-class:: classref-property-setget

  • void set_origin ( Vector3 value )
  • Vector3 get_origin ( )

The location of the rudder.

Clone this wiki locally