Difference between revisions of "HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Slide"

From Frictional Wiki
Jump to navigation Jump to search
(Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...")
 
(No difference)

Latest revision as of 01:07, 16 November 2020

Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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

Summary

Return Type Function and Description
void Slide_AutoMoveTo(const tString &in asName, float afAmount)
Auto moves the slide prop to a specific amount?
bool Slide_GetLocked(const tString &in asName)
Get if the slide prop is locked
float Slide_GetSlideAmount(const tString &in asName)
Gets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max
cVector3f Slide_GetSlideVel(const tString &in asName)
Gets the velocity of the slide joint
void Slide_SetLocked(const tString &in asName, bool abLocked, bool abEffects)
Locks/Unlocks a slide prop
void Slide_SetSlideAmount(const tString &in asName, float afAmount)
Sets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max

Function Detail

Slide_AutoMoveTo

void Slide_AutoMoveTo(const tString &in asName,
                      float afAmount)

Auto moves the slide prop to a specific amount?

Parameters

  • asName (tString) —
  • afAmount (float) —

Returns:

  • void

Slide_GetLocked

bool Slide_GetLocked(const tString &in asName)

Get if the slide prop is locked.

Parameters

Returns:

  • bool—

Slide_GetSlideAmount

float Slide_GetSlideAmount(const tString &in asName)

Gets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max.

Parameters

Returns:

  • float—float, the slide amount.

Slide_GetSlideVel

cVector3f Slide_GetSlideVel(const tString &in asName)

Gets the velocity of the slide joint.

Parameters

Returns:

  • cVector3f—cVector3f, the vel of the slide joint.

Slide_SetLocked

void Slide_SetLocked(const tString &in asName,
                     bool abLocked,
                     bool abEffects)

Locks/Unlocks a slide prop.

Parameters

  • asName (tString) —
  • abLocked (bool) —
  • abEffects (bool) —

Returns:

  • void

Slide_SetSlideAmount

void Slide_SetSlideAmount(const tString &in asName,
                          float afAmount)

Sets the slide amount of a Slide prop, 0 being at it' min position and 1 being at its max.

Parameters

  • asName (tString) —
  • afAmount (float) —

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Slide&oldid=6172"