HPL3/Amnesia: Rebirth/Scripting/iPhysicsRope

From Frictional Wiki
Jump to navigation Jump to search

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Contents

Fields

iPhysicsRope has no public fields.

Functions

Return Type Function And Description
bool GetActive()
iPhysicsBody GetAttachedEndBody()
iPhysicsBody GetAttachedStartBody()
float GetAutoMoveAcc()
bool GetAutoMoveActive()
float GetAutoMoveMaxSpeed()
float GetAutoMoveSpeed()
bool GetCollide()
bool GetCollideAttachments()
bool GetCollideCharacter()
uint GetCollideFlags()
bool GetCollideRagDoll()
float GetDamping()
cVerletParticle GetEndParticle()
float GetFirstSegmentLength()
cVector3f GetGravityForce()
int GetMaxIterations()
float GetMaxTotalLength()
float GetMinTotalLength()
bool GetMotorActive()
float GetMotorMaxSpeed()
float GetMotorMinSpeed()
tString GetMotorSound()
float GetMotorSoundStartSpeed()
float GetMotorSoundStopSpeed()
float GetMotorSpeedMul()
float GetMotorWantedLength()
tString GetName()
cVerletParticle GetParticle(int alIdx)
int GetParticleNum()
float GetParticleRadius()
bool GetPhysicsActive()
float GetSegmentLength()
float GetSlideAmount()
cVerletParticle GetStartParticle()
float GetStiffness()
float GetStrength()
float GetTotalLength()
int GetUniqueID()
int GetUpdateCount()
void IncUpdateCount()
void RemoveAttachedBody(iPhysicsBody@ apBody, bool abRemoveContainerFromBody)
void RenderDebug(iLowLevelGraphics@ apLowLevel)
void SetActive(bool abX)
void SetAttachedEndBody(iPhysicsBody@ apBody)
void SetAttachedStartBody(iPhysicsBody@ apBody)
void SetAutoMoveAcc(float afX)
void SetAutoMoveActive(bool abX)
void SetAutoMoveMaxSpeed(float afX)
void SetAutoMoveSpeed(float afX)
void SetCollide(bool abX)
void SetCollideAttachments(bool abX)
void SetCollideCharacter(bool abX)
void SetCollideFlags(uint alX)
void SetCollideRagDoll(bool abX)
void SetDamping(float afX)
void SetGravityForce(const cVector3f &in avX)
void SetMaxIterations(int alX)
void SetMaxTotalLength(float afX)
void SetMinTotalLength(float afX)
void SetMotorActive(bool abX)
void SetMotorMaxSpeed(float afX)
void SetMotorMinSpeed(float afX)
void SetMotorSound(const tString &in asSound)
void SetMotorSoundStartSpeed(float afX)
void SetMotorSoundStopSpeed(float afX)
void SetMotorSpeedMul(float afX)
void SetMotorWantedLength(float afX)
void SetParticleRadius(float afX)
void SetPhysicsActive(bool abX)
void SetSegmentLength(float afX)
void SetSleeping(bool abX)
void SetSleepParamters(float afSleepCheckInterval, float afSleepCheckDistance, int alSleepCountMax)
void SetSlideAmount(float afX)
void SetStiffness(float afX)
void SetStrength(float afX)
void SetTotalLength(float afX)
void UpdateConstraints()
void UpdateLengthConstraint(cVerletParticle@ apP1, cVerletParticle@ apP2, float afLength)
void UpdateLengthConstraint(cVerletParticle@ apP1, cVerletParticle@ apP2, float afLength, float afStiffness)
void UpdateLengthConstraint(cVerletParticle@ apP1, cVerletParticle@ apP2, float afMinLength, float afMaxLength, float afStiffness)
void UpdateLengthConstraintStretch(cVerletParticle@ apP1, cVerletParticle@ apP2, float afLength, float afStiffness)
void UpdateParticleCollisionConstraint(cVerletParticle@ apPart, const cVector3f &in avPrevPos, float afRadius)

Details

GetActive

bool GetActive()

Returns:

  • bool

GetAttachedEndBody

iPhysicsBody@ GetAttachedEndBody()

Returns:

  • iPhysicsBody@

GetAttachedStartBody

iPhysicsBody@ GetAttachedStartBody()

Returns:

  • iPhysicsBody@

GetAutoMoveAcc

float GetAutoMoveAcc()

Returns:

  • float

GetAutoMoveActive

bool GetAutoMoveActive()

Returns:

  • bool

GetAutoMoveMaxSpeed

float GetAutoMoveMaxSpeed()

Returns:

  • float

GetAutoMoveSpeed

float GetAutoMoveSpeed()

Returns:

  • float

GetCollide

bool GetCollide()

Returns:

  • bool

GetCollideAttachments

bool GetCollideAttachments()

Returns:

  • bool

GetCollideCharacter

bool GetCollideCharacter()

Returns:

  • bool

GetCollideFlags

uint GetCollideFlags()

Returns:

  • uint

GetCollideRagDoll

bool GetCollideRagDoll()

Returns:

  • bool

GetDamping

float GetDamping()

Returns:

  • float

GetEndParticle

cVerletParticle@ GetEndParticle()

Returns:

  • cVerletParticle@

GetFirstSegmentLength

float GetFirstSegmentLength()

Returns:

  • float

GetGravityForce

const cVector3f& GetGravityForce()

Returns:

  • const cVector3f&

GetMaxIterations

int GetMaxIterations()

Returns:

  • int

GetMaxTotalLength

float GetMaxTotalLength()

Returns:

  • float

GetMinTotalLength

float GetMinTotalLength()

Returns:

  • float

GetMotorActive

bool GetMotorActive()

Returns:

  • bool

GetMotorMaxSpeed

float GetMotorMaxSpeed()

Returns:

  • float

GetMotorMinSpeed

float GetMotorMinSpeed()

Returns:

  • float

GetMotorSound

const tString& GetMotorSound()

Returns:

  • const tString&

GetMotorSoundStartSpeed

float GetMotorSoundStartSpeed()

Returns:

  • float

GetMotorSoundStopSpeed

float GetMotorSoundStopSpeed()

Returns:

  • float

GetMotorSpeedMul

float GetMotorSpeedMul()

Returns:

  • float

GetMotorWantedLength

float GetMotorWantedLength()

Returns:

  • float

GetName

const tString& GetName()

Returns:

  • const tString&

GetParticle

cVerletParticle@ GetParticle(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • cVerletParticle@

GetParticleNum

int GetParticleNum()

Returns:

  • int

GetParticleRadius

float GetParticleRadius()

Returns:

  • float

GetPhysicsActive

bool GetPhysicsActive()

Returns:

  • bool

GetSegmentLength

float GetSegmentLength()

Returns:

  • float

GetSlideAmount

float GetSlideAmount()

Returns:

  • float

GetStartParticle

cVerletParticle@ GetStartParticle()

Returns:

  • cVerletParticle@

GetStiffness

float GetStiffness()

Returns:

  • float

GetStrength

float GetStrength()

Returns:

  • float

GetTotalLength

float GetTotalLength()

Returns:

  • float

GetUniqueID

int GetUniqueID()

Returns:

  • int

GetUpdateCount

int GetUpdateCount()

Returns:

  • int

IncUpdateCount

void IncUpdateCount()

Returns:

  • void

RemoveAttachedBody

void RemoveAttachedBody(iPhysicsBody@ apBody,
                        bool abRemoveContainerFromBody)


Parameters

Returns:

  • void

RenderDebug

void RenderDebug(iLowLevelGraphics@ apLowLevel)


Parameters

Returns:

  • void

SetActive

void SetActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetAttachedEndBody

void SetAttachedEndBody(iPhysicsBody@ apBody)


Parameters

Returns:

  • void

SetAttachedStartBody

void SetAttachedStartBody(iPhysicsBody@ apBody)


Parameters

Returns:

  • void

SetAutoMoveAcc

void SetAutoMoveAcc(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetAutoMoveActive

void SetAutoMoveActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetAutoMoveMaxSpeed

void SetAutoMoveMaxSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetAutoMoveSpeed

void SetAutoMoveSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetCollide

void SetCollide(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCollideAttachments

void SetCollideAttachments(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCollideCharacter

void SetCollideCharacter(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCollideFlags

void SetCollideFlags(uint alX)


Parameters

  • alX (uint) —

Returns:

  • void

SetCollideRagDoll

void SetCollideRagDoll(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetDamping

void SetDamping(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetGravityForce

void SetGravityForce(const cVector3f &in avX)


Parameters

Returns:

  • void

SetMaxIterations

void SetMaxIterations(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetMaxTotalLength

void SetMaxTotalLength(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMinTotalLength

void SetMinTotalLength(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMotorActive

void SetMotorActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetMotorMaxSpeed

void SetMotorMaxSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMotorMinSpeed

void SetMotorMinSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMotorSound

void SetMotorSound(const tString &in asSound)


Parameters

Returns:

  • void

SetMotorSoundStartSpeed

void SetMotorSoundStartSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMotorSoundStopSpeed

void SetMotorSoundStopSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMotorSpeedMul

void SetMotorSpeedMul(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMotorWantedLength

void SetMotorWantedLength(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetParticleRadius

void SetParticleRadius(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetPhysicsActive

void SetPhysicsActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSegmentLength

void SetSegmentLength(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSleeping

void SetSleeping(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSleepParamters

void SetSleepParamters(float afSleepCheckInterval,
                       float afSleepCheckDistance,
                       int alSleepCountMax)


Parameters

  • afSleepCheckInterval (float) —
  • afSleepCheckDistance (float) —
  • alSleepCountMax (int) —

Returns:

  • void

SetSlideAmount

void SetSlideAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetStiffness

void SetStiffness(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetStrength

void SetStrength(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetTotalLength

void SetTotalLength(float afX)


Parameters

  • afX (float) —

Returns:

  • void

UpdateConstraints

void UpdateConstraints()

Returns:

  • void

UpdateLengthConstraint

void UpdateLengthConstraint(cVerletParticle@ apP1,
                            cVerletParticle@ apP2,
                            float afLength)


Parameters

Returns:

  • void

UpdateLengthConstraint

void UpdateLengthConstraint(cVerletParticle@ apP1,
                            cVerletParticle@ apP2,
                            float afLength,
                            float afStiffness)


Parameters

Returns:

  • void

UpdateLengthConstraint

void UpdateLengthConstraint(cVerletParticle@ apP1,
                            cVerletParticle@ apP2,
                            float afMinLength,
                            float afMaxLength,
                            float afStiffness)


Parameters

Returns:

  • void

UpdateLengthConstraintStretch

void UpdateLengthConstraintStretch(cVerletParticle@ apP1,
                                   cVerletParticle@ apP2,
                                   float afLength,
                                   float afStiffness)


Parameters

Returns:

  • void

UpdateParticleCollisionConstraint

void UpdateParticleCollisionConstraint(cVerletParticle@ apPart,
                                       const cVector3f &in avPrevPos,
                                       float afRadius)


Parameters

Returns:

  • void

References

See all references...