![]() |
RigsofRods
2023.09
Soft-body Physics Simulation
|
Binding of RoR::Actor; a softbody-physics gameplay object, can be anything from soda can to space shuttle. More...
#include <BeamClass.h>
Public Member Functions | |
Physics state | |
| TruckState | getTruckState () |
| vector3 | getPosition () |
| Get vehicle absolute position. More... | |
| vector3 | getVehiclePosition () |
| float | getRotation () |
| Returns the angle in which the truck is heading. More... | |
| float | getHeadingDirectionAngle () |
| Returns the angle in which the truck is heading. More... | |
| quaternion | getOrientation () float getSpeed() |
| Orientation on all axes packed to single quaternion. More... | |
| vector3 | getGForces () |
| Gets the G-forces that this truck is currently experiencing. More... | |
| float | getTotalMass (bool withLocked) |
| Gets the total mass of the truck. More... | |
| int | getNodeCount () |
| Gets the total amount of nodes of the truck. More... | |
| vector3 | getNodePosition (int nodeNumber) |
| Returns the position of the node. More... | |
| vector3 | isNodeWheelRim (int nodeNumber) |
| Is node marked as wheel rim? Note some wheel models use only tire nodes. More... | |
| vector3 | isNodeWheelTire (int nodeNumber) |
| Is node marked as wheel tire? Note some wheel models use only tire nodes. More... | |
| int | getWheelNodeCount () |
| Gets the total amount of nodes of the wheels of the truck. More... | |
| float | getWheelSpeed () |
| Gets the current wheel speed of the vehicle. More... | |
| void | reset (bool keep_position) |
| Resets the truck. More... | |
| TruckState | getTruckState () |
| vector3 | getPosition () |
| Get vehicle absolute position. More... | |
| vector3 | getVehiclePosition () |
| float | getRotation () |
| Returns the angle in which the truck is heading. More... | |
| float | getHeadingDirectionAngle () |
| Returns the angle in which the truck is heading. More... | |
| quaternion | getOrientation () float getSpeed() |
| Orientation on all axes packed to single quaternion. More... | |
| vector3 | getGForces () |
| Gets the G-forces that this truck is currently experiencing. More... | |
| float | getTotalMass (bool withLocked) |
| Gets the total mass of the truck. More... | |
| int | getNodeCount () |
| Gets the total amount of nodes of the truck. More... | |
| vector3 | getNodePosition (int nodeNumber) |
| Returns the position of the node. More... | |
| vector3 | isNodeWheelRim (int nodeNumber) |
| Is node marked as wheel rim? Note some wheel models use only tire nodes. More... | |
| vector3 | isNodeWheelTire (int nodeNumber) |
| Is node marked as wheel tire? Note some wheel models use only tire nodes. More... | |
| int | getWheelNodeCount () |
| Gets the total amount of nodes of the wheels of the truck. More... | |
| float | getWheelSpeed () |
| Gets the current wheel speed of the vehicle. More... | |
| void | reset (bool keep_position) |
| Resets the truck. More... | |
Physics editing | |
| void | scaleTruck (float ratio) |
| Scales the truck. More... | |
| void | setMass (float m) |
| Sets the mass of the truck. More... | |
| void | setSimAttribute (ActorSimAttr attr, float val) |
| Allows advanced users to set physics settings directly, including some not accessible from rig-def file format. More... | |
| float | getSimAttribute (ActorSimAttr attr) |
| void | scaleTruck (float ratio) |
| Scales the truck. More... | |
| void | setMass (float m) |
| Sets the mass of the truck. More... | |
| void | setSimAttribute (ActorSimAttr attr, float val) |
| Allows advanced users to set physics settings directly, including some not accessible from rig-def file format. More... | |
| float | getSimAttribute (ActorSimAttr attr) |
User interaction | |
| void | parkingbrakeToggle () |
| Toggles the parking brake. More... | |
| void | tractioncontrolToggle () |
| Toggles the tracktion control. More... | |
| void | antilockbrakeToggle () |
| Toggles the anti-lock brakes. More... | |
| void | toggleCustomParticles () |
| Toggles the custom particles. More... | |
| bool | getCustomParticleMode () |
| Gets the custom particles mode. More... | |
| bool | isLocked () |
| Returns true if a hook of this truck is locked. More... | |
| void | setForcedCinecam (int cinecamId, int flags) |
| Sets a forced cinecam for this actor; This disables camera hotkeys. More... | |
| void | clearForcedCinecam () |
Resets the effect of setForcedCinecam();. More... | |
| bool | getForcedCinecam (int &inout, int &inout) |
Reports the values submitted by setForcedCinecam();. More... | |
| int | getNumCinecams () const |
| Reports number of installed cinecams. More... | |
| void | parkingbrakeToggle () |
| Toggles the parking brake. More... | |
| void | tractioncontrolToggle () |
| Toggles the tracktion control. More... | |
| void | antilockbrakeToggle () |
| Toggles the anti-lock brakes. More... | |
| void | toggleCustomParticles () |
| Toggles the custom particles. More... | |
| bool | getCustomParticleMode () |
| Gets the custom particles mode. More... | |
| bool | isLocked () |
| Returns true if a hook of this truck is locked. More... | |
| void | setForcedCinecam (int cinecamId, int flags) |
| Sets a forced cinecam for this actor; This disables camera hotkeys. More... | |
| void | clearForcedCinecam () |
Resets the effect of setForcedCinecam();. More... | |
| bool | getForcedCinecam (int &inout, int &inout) |
Reports the values submitted by setForcedCinecam();. More... | |
| int | getNumCinecams () const |
| Reports number of installed cinecams. More... | |
Subsystems | |
| VehicleAiClass | getVehicleAI () |
| Retrieve the waypoint AI object. More... | |
| EngineClassPtr | getEngine () |
| Retrieve engine/transmission simulator. More... | |
| VehicleAiClass | getVehicleAI () |
| Retrieve the waypoint AI object. More... | |
| EngineClassPtr | getEngine () |
| Retrieve engine/transmission simulator. More... | |
Vehicle lights | |
| int | getBlinkType () |
| Gets the blinking type. More... | |
| void | setBlinkType (int blink) |
| Sets the blinking type. More... | |
| bool | getCustomLightVisible (int number) |
| Returns true if the custom light with the number number is enabled. More... | |
| void | setCustomLightVisible (int number, bool visible) |
| Enables or disables the custom light. More... | |
| bool | getBeaconMode () |
| Gets the mode of the beacon. More... | |
| void | beaconsToggle () |
| Toggles the beacons. More... | |
| bool | getBrakeLightVisible () |
| Returns true if the brake light is enabled. More... | |
| bool | getReverseLightVisible () |
| Returns true if the reverse lights are enabled. More... | |
| int | countCustomLights (int) |
| Counts flares using the given custom light group number (1-10). More... | |
| int | countFlaresByType (FlareType) |
| Counts flares using the given type. More... | |
| int | getBlinkType () |
| Gets the blinking type. More... | |
| void | setBlinkType (int blink) |
| Sets the blinking type. More... | |
| bool | getCustomLightVisible (int number) |
| Returns true if the custom light with the number number is enabled. More... | |
| void | setCustomLightVisible (int number, bool visible) |
| Enables or disables the custom light. More... | |
| bool | getBeaconMode () |
| Gets the mode of the beacon. More... | |
| void | beaconsToggle () |
| Toggles the beacons. More... | |
| bool | getBrakeLightVisible () |
| Returns true if the brake light is enabled. More... | |
| bool | getReverseLightVisible () |
| Returns true if the reverse lights are enabled. More... | |
| int | countCustomLights (int) |
| Counts flares using the given custom light group number (1-10). More... | |
| int | countFlaresByType (FlareType) |
| Counts flares using the given type. More... | |
Organizational | |
| string | getTruckName () |
| Gets the designated name of the truck. More... | |
| string | getTruckFileName () |
| Gets the name of the truck definition file. More... | |
| string | getTruckFileResourceGroup () |
| Gets the name of the OGRE resource group where the truck definition file lives. More... | |
| string | getSectionConfig () |
| Gets the name of the loaded section for a truck. More... | |
| int | getInstanceId () |
Gets the unique Actor Instance ID; The same value as provided by Game2Script::eventCallbackEx(). More... | |
| string | getTruckName () |
| Gets the designated name of the truck. More... | |
| string | getTruckFileName () |
| Gets the name of the truck definition file. More... | |
| string | getTruckFileResourceGroup () |
| Gets the name of the OGRE resource group where the truck definition file lives. More... | |
| string | getSectionConfig () |
| Gets the name of the loaded section for a truck. More... | |
| int | getInstanceId () |
Gets the unique Actor Instance ID; The same value as provided by Game2Script::eventCallbackEx(). More... | |
Binding of RoR::Actor; a softbody-physics gameplay object, can be anything from soda can to space shuttle.
Definition at line 15 of file BeamClass.h.
| void Script2Game::BeamClass::antilockbrakeToggle | ( | ) |
Toggles the anti-lock brakes.
| void Script2Game::BeamClass::antilockbrakeToggle | ( | ) |
Toggles the anti-lock brakes.
| void Script2Game::BeamClass::beaconsToggle | ( | ) |
Toggles the beacons.
| void Script2Game::BeamClass::beaconsToggle | ( | ) |
Toggles the beacons.
| void Script2Game::BeamClass::clearForcedCinecam | ( | ) |
Resets the effect of setForcedCinecam();.
| void Script2Game::BeamClass::clearForcedCinecam | ( | ) |
Resets the effect of setForcedCinecam();.
| int Script2Game::BeamClass::countCustomLights | ( | int | ) |
Counts flares using the given custom light group number (1-10).
| int Script2Game::BeamClass::countCustomLights | ( | int | ) |
Counts flares using the given custom light group number (1-10).
| int Script2Game::BeamClass::countFlaresByType | ( | FlareType | ) |
Counts flares using the given type.
| int Script2Game::BeamClass::countFlaresByType | ( | FlareType | ) |
Counts flares using the given type.
| bool Script2Game::BeamClass::getBeaconMode | ( | ) |
Gets the mode of the beacon.
| bool Script2Game::BeamClass::getBeaconMode | ( | ) |
Gets the mode of the beacon.
| int Script2Game::BeamClass::getBlinkType | ( | ) |
Gets the blinking type.
| int Script2Game::BeamClass::getBlinkType | ( | ) |
Gets the blinking type.
| bool Script2Game::BeamClass::getBrakeLightVisible | ( | ) |
Returns true if the brake light is enabled.
| bool Script2Game::BeamClass::getBrakeLightVisible | ( | ) |
Returns true if the brake light is enabled.
| bool Script2Game::BeamClass::getCustomLightVisible | ( | int | number | ) |
Returns true if the custom light with the number number is enabled.
| bool Script2Game::BeamClass::getCustomLightVisible | ( | int | number | ) |
Returns true if the custom light with the number number is enabled.
| bool Script2Game::BeamClass::getCustomParticleMode | ( | ) |
Gets the custom particles mode.
| bool Script2Game::BeamClass::getCustomParticleMode | ( | ) |
Gets the custom particles mode.
| EngineClassPtr Script2Game::BeamClass::getEngine | ( | ) |
Retrieve engine/transmission simulator.
| EngineClassPtr Script2Game::BeamClass::getEngine | ( | ) |
Retrieve engine/transmission simulator.
| bool Script2Game::BeamClass::getForcedCinecam | ( | int & | inout, |
| int & | inout | ||
| ) |
Reports the values submitted by setForcedCinecam();.
| cinecamId | Cinecams are numbered from 0, use getNumCinecams(); -1 means no cinecam. |
| flags | Flags are reserved for future use. |
| bool Script2Game::BeamClass::getForcedCinecam | ( | int & | inout, |
| int & | inout | ||
| ) |
Reports the values submitted by setForcedCinecam();.
| cinecamId | Cinecams are numbered from 0, use getNumCinecams(); -1 means no cinecam. |
| flags | Flags are reserved for future use. |
| vector3 Script2Game::BeamClass::getGForces | ( | ) |
Gets the G-forces that this truck is currently experiencing.
| vector3 Script2Game::BeamClass::getGForces | ( | ) |
Gets the G-forces that this truck is currently experiencing.
| float Script2Game::BeamClass::getHeadingDirectionAngle | ( | ) |
Returns the angle in which the truck is heading.
| float Script2Game::BeamClass::getHeadingDirectionAngle | ( | ) |
Returns the angle in which the truck is heading.
| int Script2Game::BeamClass::getInstanceId | ( | ) |
Gets the unique Actor Instance ID; The same value as provided by Game2Script::eventCallbackEx().
| int Script2Game::BeamClass::getInstanceId | ( | ) |
Gets the unique Actor Instance ID; The same value as provided by Game2Script::eventCallbackEx().
| int Script2Game::BeamClass::getNodeCount | ( | ) |
Gets the total amount of nodes of the truck.
| int Script2Game::BeamClass::getNodeCount | ( | ) |
Gets the total amount of nodes of the truck.
| vector3 Script2Game::BeamClass::getNodePosition | ( | int | nodeNumber | ) |
Returns the position of the node.
| the | number of the node (counts from 0, see getNodeCount()) |
| vector3 Script2Game::BeamClass::getNodePosition | ( | int | nodeNumber | ) |
Returns the position of the node.
| the | number of the node (counts from 0, see getNodeCount()) |
| int Script2Game::BeamClass::getNumCinecams | ( | ) | const |
Reports number of installed cinecams.
| int Script2Game::BeamClass::getNumCinecams | ( | ) | const |
Reports number of installed cinecams.
| quaternion Script2Game::BeamClass::getOrientation | ( | ) |
Orientation on all axes packed to single quaternion.
Use getYaw(), getPitch() and getRoll() for individual rotations in radians. Meters per second.
| quaternion Script2Game::BeamClass::getOrientation | ( | ) |
Orientation on all axes packed to single quaternion.
Use getYaw(), getPitch() and getRoll() for individual rotations in radians. Meters per second.
| vector3 Script2Game::BeamClass::getPosition | ( | ) |
Get vehicle absolute position.
| vector3 Script2Game::BeamClass::getPosition | ( | ) |
Get vehicle absolute position.
| bool Script2Game::BeamClass::getReverseLightVisible | ( | ) |
Returns true if the reverse lights are enabled.
| bool Script2Game::BeamClass::getReverseLightVisible | ( | ) |
Returns true if the reverse lights are enabled.
| float Script2Game::BeamClass::getRotation | ( | ) |
Returns the angle in which the truck is heading.
| float Script2Game::BeamClass::getRotation | ( | ) |
Returns the angle in which the truck is heading.
| string Script2Game::BeamClass::getSectionConfig | ( | ) |
Gets the name of the loaded section for a truck.
| string Script2Game::BeamClass::getSectionConfig | ( | ) |
Gets the name of the loaded section for a truck.
| float Script2Game::BeamClass::getSimAttribute | ( | ActorSimAttr | attr | ) |
| float Script2Game::BeamClass::getSimAttribute | ( | ActorSimAttr | attr | ) |
| float Script2Game::BeamClass::getTotalMass | ( | bool | withLocked | ) |
Gets the total mass of the truck.
| withLocked | if true, the mass of everything locked to the truck will be added to the mass of the truck. |
| float Script2Game::BeamClass::getTotalMass | ( | bool | withLocked | ) |
Gets the total mass of the truck.
| withLocked | if true, the mass of everything locked to the truck will be added to the mass of the truck. |
| string Script2Game::BeamClass::getTruckFileName | ( | ) |
Gets the name of the truck definition file.
| string Script2Game::BeamClass::getTruckFileName | ( | ) |
Gets the name of the truck definition file.
| string Script2Game::BeamClass::getTruckFileResourceGroup | ( | ) |
Gets the name of the OGRE resource group where the truck definition file lives.
Useful for loading using GenericDocumentClass.
| string Script2Game::BeamClass::getTruckFileResourceGroup | ( | ) |
Gets the name of the OGRE resource group where the truck definition file lives.
Useful for loading using GenericDocumentClass.
| string Script2Game::BeamClass::getTruckName | ( | ) |
Gets the designated name of the truck.
| string Script2Game::BeamClass::getTruckName | ( | ) |
Gets the designated name of the truck.
| TruckState Script2Game::BeamClass::getTruckState | ( | ) |
| TruckState Script2Game::BeamClass::getTruckState | ( | ) |
| VehicleAiClass Script2Game::BeamClass::getVehicleAI | ( | ) |
Retrieve the waypoint AI object.
| VehicleAiClass Script2Game::BeamClass::getVehicleAI | ( | ) |
Retrieve the waypoint AI object.
| vector3 Script2Game::BeamClass::getVehiclePosition | ( | ) |
getPosition() | vector3 Script2Game::BeamClass::getVehiclePosition | ( | ) |
getPosition() | int Script2Game::BeamClass::getWheelNodeCount | ( | ) |
Gets the total amount of nodes of the wheels of the truck.
| int Script2Game::BeamClass::getWheelNodeCount | ( | ) |
Gets the total amount of nodes of the wheels of the truck.
| float Script2Game::BeamClass::getWheelSpeed | ( | ) |
Gets the current wheel speed of the vehicle.
| float Script2Game::BeamClass::getWheelSpeed | ( | ) |
Gets the current wheel speed of the vehicle.
| bool Script2Game::BeamClass::isLocked | ( | ) |
Returns true if a hook of this truck is locked.
| bool Script2Game::BeamClass::isLocked | ( | ) |
Returns true if a hook of this truck is locked.
| vector3 Script2Game::BeamClass::isNodeWheelRim | ( | int | nodeNumber | ) |
Is node marked as wheel rim? Note some wheel models use only tire nodes.
See https://docs.rigsofrods.org/vehicle-creation/fileformat-truck/#wheels
| the | number of the node (counts from 0, see getNodeCount()) |
| vector3 Script2Game::BeamClass::isNodeWheelRim | ( | int | nodeNumber | ) |
Is node marked as wheel rim? Note some wheel models use only tire nodes.
See https://docs.rigsofrods.org/vehicle-creation/fileformat-truck/#wheels
| the | number of the node (counts from 0, see getNodeCount()) |
| vector3 Script2Game::BeamClass::isNodeWheelTire | ( | int | nodeNumber | ) |
Is node marked as wheel tire? Note some wheel models use only tire nodes.
See https://docs.rigsofrods.org/vehicle-creation/fileformat-truck/#wheels
| the | number of the node (counts from 0, see getNodeCount()) |
| vector3 Script2Game::BeamClass::isNodeWheelTire | ( | int | nodeNumber | ) |
Is node marked as wheel tire? Note some wheel models use only tire nodes.
See https://docs.rigsofrods.org/vehicle-creation/fileformat-truck/#wheels
| the | number of the node (counts from 0, see getNodeCount()) |
| void Script2Game::BeamClass::parkingbrakeToggle | ( | ) |
Toggles the parking brake.
| void Script2Game::BeamClass::parkingbrakeToggle | ( | ) |
Toggles the parking brake.
| void Script2Game::BeamClass::reset | ( | bool | keep_position | ) |
Resets the truck.
| reset_position | true if you want to keep the truck at the current position. (otherwise, it will be moved to its origin position) |
| void Script2Game::BeamClass::reset | ( | bool | keep_position | ) |
Resets the truck.
| reset_position | true if you want to keep the truck at the current position. (otherwise, it will be moved to its origin position) |
| void Script2Game::BeamClass::scaleTruck | ( | float | ratio | ) |
Scales the truck.
| void Script2Game::BeamClass::scaleTruck | ( | float | ratio | ) |
Scales the truck.
| void Script2Game::BeamClass::setBlinkType | ( | int | blink | ) |
Sets the blinking type.
| void Script2Game::BeamClass::setBlinkType | ( | int | blink | ) |
Sets the blinking type.
| void Script2Game::BeamClass::setCustomLightVisible | ( | int | number, |
| bool | visible | ||
| ) |
Enables or disables the custom light.
| void Script2Game::BeamClass::setCustomLightVisible | ( | int | number, |
| bool | visible | ||
| ) |
Enables or disables the custom light.
| void Script2Game::BeamClass::setForcedCinecam | ( | int | cinecamId, |
| int | flags | ||
| ) |
Sets a forced cinecam for this actor; This disables camera hotkeys.
| cinecamId | Cinecams are numbered from 0, use getNumCinecams(); -1 means no cinecam. |
| flags | Flags are reserved for future use. |
| void Script2Game::BeamClass::setForcedCinecam | ( | int | cinecamId, |
| int | flags | ||
| ) |
Sets a forced cinecam for this actor; This disables camera hotkeys.
| cinecamId | Cinecams are numbered from 0, use getNumCinecams(); -1 means no cinecam. |
| flags | Flags are reserved for future use. |
| void Script2Game::BeamClass::setMass | ( | float | m | ) |
Sets the mass of the truck.
| void Script2Game::BeamClass::setMass | ( | float | m | ) |
Sets the mass of the truck.
| void Script2Game::BeamClass::setSimAttribute | ( | ActorSimAttr | attr, |
| float | val | ||
| ) |
Allows advanced users to set physics settings directly, including some not accessible from rig-def file format.
HAZARDOUS - values may not be checked; Pay attention to 'safe values' at each attribute description.
| void Script2Game::BeamClass::setSimAttribute | ( | ActorSimAttr | attr, |
| float | val | ||
| ) |
Allows advanced users to set physics settings directly, including some not accessible from rig-def file format.
HAZARDOUS - values may not be checked; Pay attention to 'safe values' at each attribute description.
| void Script2Game::BeamClass::toggleCustomParticles | ( | ) |
Toggles the custom particles.
| void Script2Game::BeamClass::toggleCustomParticles | ( | ) |
Toggles the custom particles.
| void Script2Game::BeamClass::tractioncontrolToggle | ( | ) |
Toggles the tracktion control.
| void Script2Game::BeamClass::tractioncontrolToggle | ( | ) |
Toggles the tracktion control.
1.8.17