CitizenFX.Core

An event containing callbacks to attempt to schedule on every game tick. A callback will only be rescheduled once the associated task completes.

Returns a task that will delay scheduling of the current interval function by the passed amount of time.

await Delay(500); The amount of time by which to delay scheduling this interval function. An awaitable task. This method allocates a sound ID. It is imperative you release the sound ID when you are done using it through

Gets or sets the position of this .

Sets the rotation of this on the map.

Sets the scale of this on the map.

Gets the type of this .

Gets or sets the alpha of this on the map.

Sets the priority of this .

Sets this s label to the given number.

Gets or sets the color of this .

Gets or sets the sprite of this .

Sets this s label to the given string.

Gets the this is attached to.

Sets a value indicating whether the route to this should be shown on the map.

true to show the route; otherwise, false.

Sets a value indicating whether this is friendly.

true if this is friendly; otherwise, false.

Sets a value indicating whether this (Player) is a friend. Toggles a half cyan circle on the right side.

true if this (Player) is a friend; otherwise, false.

Sets a value indicating whether this (Player) is a CREW member. Toggles a half cyan circle on the left side.

true if this (Player) is a CREW member; otherwise, false.

Gets or sets a value indicating whether this is flashing.

true if this is flashing; otherwise, false.

Gets a value indicating whether this is on minimap.

true if this is on minimap; otherwise, false.

Gets or sets a value indicating whether this is short range.

true if this is short range; otherwise, false.

Removes the number label for this .

Adds a cone for this

'Width' of the cone (0.0f - pi) Distance of the cone Heading of the cone in radians (degrees * pi / 180) Color of the cone (see hud colors/> Unknown at this time Unknown at this time Unknown at this time Unknown at this time

Removes the cone for this

Removes this .

The Buttons enum used for creating s

A value type used for checking if a sequence of s has been pressed. Check if the combination has been entered with .

Gets the calculated hash of the Sequence

Gets the length of the sequence

Creates a from a given list of s.

The sequence of s in the order a user should enter in game. There must be between 6 and 29 inclusive s otherwise an is thrown

Gets the memory address of this .

Gets or sets a value indicating whether this is currently being rendered.

true if this is active; otherwise, false.

Gets or sets the position of this .

Gets or sets the rotation of this .

The yaw, pitch and roll rotations measured in degrees.

Gets or sets the direction this is pointing in.

Gets the up vector of this .

Gets the forward vector of this , see also .

Gets the right vector of this .

Gets the matrix of this .

Gets the position in world coords of an offset relative to this

The offset from this .

Gets the relative offset of this from a world coords position

The world coords.

Gets or sets the field of view of this .

Gets or sets the near clip of this .

Gets or sets the far clip of this .

Sets the near depth of field for this .

Gets or sets the far depth of field of this .

Sets the depth of field strength for this .

Sets the strenght of the motion blur for this

Shakes this .

Type of the shake to apply. The amplitude of the shaking.

Stops shaking this .

Gets a value indicating whether this is shaking.

true if this is shaking; otherwise, false.

Sets the shake amplitude for this .

Points this at a specified .

The to point at. The offset from the to point at.

Points this at a specified .

The to point at. The offset from the to point at

Points this at a specified position.

The position to point at.

Stops this pointing at a specific target.

Starts a transition between this and the new camera. (Old (incorrect) function, please use the overload function!)

Starts a transition between this and the new camera.

Gets a value indicating whether this is interpolating.

true if this is interpolating; otherwise, false.

Attaches this to a specific .

The to attach to. The offset from the to attach to.

Attaches this to a specific .

The to attach to. The offset from the to attach to.

Detaches this from any or it may be attached to.

Destroys this .

Gets the memory address of the .

Gets the position of the .

Gets the rotation of the .

The yaw, pitch and roll rotations measured in degrees.

Gets the direction the is pointing in.

Gets the up vector of the .

Gets the forward vector of the , see also .

Gets the right vector of the .

Gets the matrix of the .

Gets the position in world coords of an offset relative to the

The offset from the .

Gets the relative offset of the from a world coords position

The world coords.

Gets or sets the relative pitch of the .

Gets or sets the relative heading of the .

Clamps the yaw of the .

The minimum yaw value. The maximum yaw value.

Clamps the pitch of the .

The minimum pitch value. The maximum pitch value.

Gets the zoom of the .

Gets the field of view of the .

Gets a value indicating whether the is rendering.

true if the is rendering; otherwise, false.

Gets a value indicating whether the aiming camera is rendering.

true if the aiming camera is rendering; otherwise, false.

Gets a value indicating whether the first person aiming camera is rendering.

true if the aiming camera is rendering; otherwise, false.

Gets a value indicating whether the is looking behind.

true if the is looking behind; otherwise, false.

Shakes the .

Type of the shake to apply. The amplitude of the shaking.

Stops shaking the .

Gets a value indicating whether the is shaking.

true if the is shaking; otherwise, false.

Sets the shake amplitude for the .

Initializes a new instance of the struct.

The icon style. The icon number, if is allowed range is 0 - 99 otherwise allowed range is 0 - 9.

Gets or sets the number to display inside the icon.

The number. if is allowed range is 0 - 99 otherwise allowed range is 0 - 9.

Gets the memory address of this .

Gets or sets the position of this .

Gets or sets the position where this points to.

Gets or sets the icon drawn in this .

Gets or sets the radius of this .

Gets or sets the color of this .

Gets or sets the color of the icon in this .

Gets or sets the near height of the cylinder of this .

Gets or sets the far height of the cylinder of this .

Gets or sets the radius of the cylinder in this .

Removes this .

Determines if this exists.

true if this exists; otherwise, false.

Determines if a specific exists.

true if the exists; otherwise, false.

Determines if a refer to the same as this .

The other . true if the is the same checkpoint as this ; otherwise, false.

Determines if an refer to the same as this .

The to check. true if the is the same checkpoint as this ; otherwise, false.

Determines if 2 s refer to the same checkpoint

The left . The right . true if is the same checkpoint as this ; otherwise, false.

Determines if 2 s don't refer to the same checkpoint

The left . The right . true if is not the same checkpoint as this ; otherwise, false.

Gets or sets a value indicating whether this will be drawn.

true if enabled; otherwise, false.

Gets or sets the color of this .

The color.

Gets or sets the position of this .

The position scaled on a 1280*720 pixel base. If ScaledDraw is called, the position will be scaled by the width returned in .

Gets or sets a value indicating whether this should be positioned based on its center or top left corner

true if centered; otherwise, false.

Draws this this frame.

Draws this this frame at the specified offset.

The offset to shift the draw position of this using a 1280*720 pixel base.

Draws this this frame using the width returned in .

Draws this this frame at the specified offset using the width returned in .

The offset to shift the draw position of this using a *720 pixel base.

Gets or sets a value indicating whether this will be drawn.

true if enabled; otherwise, false.

Gets or sets the color of this .

The color.

Gets or sets the position of this .

The position scaled on a 1280*720 pixel base. If ScaledDraw is called, the position will be scaled by the width returned in .

Gets or sets a value indicating whether this should be positioned based on its center or top left corner

true if centered; otherwise, false.

Gets or sets the size to draw the

The size on a 1280*720 pixel base If ScaledDraw is called, the size will be scaled by the width returned in .

Initializes a new instance of the class used for grouping drawing Rectangles on screen.

Set the on screen where to draw the . Set the of the .

Initializes a new instance of the class used for grouping drawing Rectangles on screen.

Set the on screen where to draw the . Set the of the . Set the used to draw the .

Initializes a new instance of the class used for grouping drawing Rectangles on screen.

Set the on screen where to draw the . Set the of the . Set the used to draw the . Position the based on its center instead of top left corner, see also .

Draws this this frame.

Draws this this frame at the specified offset.

The offset to shift the draw position of this using a 1280*720 pixel base.

Draws this this frame using the width returned in .

Draws this this frame at the specified offset using the width returned in .

The offset to shift the draw position of this using a *720 pixel base.

The s Contained inside this

Initializes a new instance of the class used for grouping s together.

Set the on screen where to draw the . Set the of the .

Initializes a new instance of the class used for grouping s together.

Set the on screen where to draw the . Set the of the . Set the used to draw the .

Initializes a new instance of the class used for grouping s together.

Set the on screen where to draw the . Set the of the . Set the used to draw the . Position the based on its center instead of top left corner, see also .

Draws this this frame and all its s.

Draws this this frame and all its s at the specified offset.

The offset to shift the draw position of this using a 1280*720 pixel base.

Draws this this frame and all its s using the width returned in .

Draws this this frame and all its s at the specified offset using the width returned in .

The offset to shift the draw position of this using a *720 pixel base.

Hides this instantly

The base width of the screen used for all UI Calculations, unless ScaledDraw is used

The base height of the screen used for all UI Calculations

Gets the current Screen Aspect Ratio

Gets the width of the scaled against a 720pixel height base.

Gets the actual Screen resolution the game is being rendered at

Shows a subtitle at the bottom of the screen for a given time

The message to display. The duration to display the subtitle in milliseconds. Use this with an array of s that have 99 or less characters for better performance

Displays a help message in the top corner of the screen this frame.

The text to display. Use this with an array of s that have 99 or less characters for better performance

Creates a above the minimap with the given message.

The message in the notification. if set to true the notification will blink. The handle of the which can be used to hide it using Use this with an array of s that have 99 or less characters for better performance

Translates a point in WorldSpace to its given Coordinates on the

The position in the World. if set to true Returns the screen position scaled by ; otherwise, returns the screen position scaled by .

Creates a loading prompt at the bottom right of the screen with the given text and spinner type

The text to display next to the spinner The style of spinner to draw , , and all see to be the same. But Rockstar always seem to use the in the scripts

Remove the loading prompt at the bottom right of the screen

Gets a value indicating whether the Loading Prompt is currently being displayed

Determines whether a given is Active.

The to check true if the is Active; otherwise, false

Draws the specified this frame.

The This will only draw the if the can be drawn

Hides the specified this frame.

The to hide.

Shows the mouse cursor this frame.

Gets or sets the sprite the cursor should used when drawn

Gets or sets a value indicating whether any HUD components should be rendered.

Gets or sets a value indicating whether the radar is visible.

Sets how far the Minimap should be zoomed in

The Radar zoom, Accepts values from 0 to 200

Gets a value indicating whether the screen is faded in.

true if the screen is faded in; otherwise, false.

Gets a value indicating whether the screen is faded out.

true if the screen is faded out; otherwise, false.

Gets a value indicating whether the screen is fading in.

true if the screen is fading in; otherwise, false.

Gets a value indicating whether the screen is fading out.

true if the screen is fading out; otherwise, false.

Fades the screen in over a specific time, useful for transitioning

The time for the fade in to take

Fades the screen out over a specific time, useful for transitioning

The time for the fade out to take

Gets or sets the size to draw the

The size on a 1280*720 pixel base If ScaledDraw is called, the size will be scaled by the width returned in .

Gets or sets the rotation to draw thie .

The rotation measured in degrees, clockwise increasing, 0.0 at vertical

Gets or sets a value indicating whether this will be drawn.

true if enabled; otherwise, false.

Gets or sets the color of this .

The color.

Gets or sets the position of this .

The position scaled on a 1280*720 pixel base. If ScaledDraw is called, the position will be scaled by the width returned in .

Gets or sets the size to draw the

The size on a 1280*720 pixel base If ScaledDraw is called, the size will be scaled by the width returned in .

Gets or sets the rotation to draw thie .

The rotation measured in degrees, clockwise increasing, 0.0 at vertical

Gets or sets a value indicating whether this should be positioned based on its center or top left corner

true if centered; otherwise, false.

Initializes a new instance of the class used for drawing in game textures on the screen.

The Texture dictionary where the is stored (the *.ytd file). Name of the inside the Texture dictionary. Set the of the . Set the on screen where to draw the .

Initializes a new instance of the class used for drawing in game textures on the screen.

The Texture dictionary where the is stored (the *.ytd file). Name of the inside the Texture dictionary. Set the of the . Set the on screen where to draw the . Set the used to draw the .

Initializes a new instance of the class used for drawing in game textures on the screen.

The Texture dictionary where the is stored (the *.ytd file). Name of the inside the Texture dictionary. Set the of the . Set the on screen where to draw the . Set the used to draw the . Set the rotation to draw the sprite, measured in degrees, see also .

Initializes a new instance of the class used for drawing in game textures on the screen.

Draws this .

Draws the at the specified offset.

The offset.

Draws this using the width returned in .

Draws the at the specified offset using the width returned in .

The offset.

Gets or sets a value indicating whether this will be drawn.

true if enabled; otherwise, false.

Gets or sets the color of this .

The color.

Gets or sets the position of this .

The position scaled on a 1280*720 pixel base. If ScaledDraw is called, the position will be scaled by the width returned in .

Gets or sets the scale of this .

The scale usually a value between ~0.5 and 3.0, Default = 1.0

Gets or sets the font of this .

The GTA Font use when drawing.

Gets or sets the text to draw in this .

The caption.

Gets or sets the alignment of this .

The alignment:Left, Center, Right Justify

Gets or sets a value indicating whether this is drawn with a shadow effect.

true if shadow; otherwise, false.

Gets or sets a value indicating whether this is drawn with an outline.

true if outline; otherwise, false.

Gets or sets the maximun size of the before it wraps to a new line.

The width of the .

Gets or sets a value indicating whether the alignment of this is centered. See

true if centered; otherwise, false.

Measures how many pixels on the horizontal axis this will use when drawn against a 1280 pixel base

Measures how many pixels in the horizontal axis this will use when drawn against a pixel base

Initializes a new instance of the class used for drawing text on the screen.

The to draw. Set the on screen where to draw the . Sets a used to increase of decrease the size of the , for no scaling use 1.0f.

Initializes a new instance of the class used for drawing text on the screen.

The to draw. Set the on screen where to draw the . Sets a used to increase of decrease the size of the , for no scaling use 1.0f. Set the used to draw the .

Initializes a new instance of the class used for drawing text on the screen.

The to draw. Set the on screen where to draw the . Sets a used to increase of decrease the size of the , for no scaling use 1.0f. Set the used to draw the . Sets the used when drawing the text.

Initializes a new instance of the class used for drawing text on the screen.

The to draw. Set the on screen where to draw the . Sets a used to increase of decrease the size of the , for no scaling use 1.0f. Set the used to draw the . Sets the used when drawing the text. Sets the used when drawing the text, , or . Sets whether or not to draw the with a effect. Sets whether or not to draw the with an around the letters. Sets how many horizontal pixel to draw before wrapping the on the next line down. will be divided in multiple strings of 99 or less characters.
Any that is 396+ characters long (5+ divisions) is known to not be rendered by GTA V.

Measures how many pixels in the horizontal axis the string will use when drawn

The string of text to measure. The to use when measuring the text's width. Sets a sclae value for increasing or decreasing the size of the text, default value 1.0f - no scaling. The amount of pixels scaled on a 1280 pixel width base The series of strings of texts to measure, each string should not be bigger than 99 characters.

Measures how many pixels in the horizontal axis the string will use when drawn

The string of text to measure. The of the textu to measure. Sets a sclae value for increasing or decreasing the size of the text, default value 1.0f - no scaling. The amount of pixels scaled by the pixel width base return in The series of strings of texts to measure, each string should not be bigger than 99 characters.

Draws the this frame.

Draws the this frame at the specified offset.

The offset to shift the draw position of this using a 1280*720 pixel base.

Draws the this frame using the width returned in .

Draws the this frame at the specified offset using the width returned in .

The offset to shift the draw position of this using a *720 pixel base.

Splits the into an array with each string having 99 characters or less
This is needed as characters beyond 99 aren't rendered by GTA V, e.g.: with

arrays of 5 and higher (396+ characters) are known to not being rendered by GTA V The string to convert. array containing strings each 99 characters or less.

Gets the memory address where the is stored in memory.

Gets or sets the health of this as an .

The health from 0 - 100 as an integer. if you need to get or set the value strictly, use instead.

Gets or sets the health of this as a .

The health in float.

Gets or sets the maximum health of this as an .

The maximum health from 0 - 100 as an integer. if you need to get or set the value strictly, use instead.

Gets or sets the maximum health of this in float.

The maximum health in float.

Gets a value indicating whether this is dead.

true if this is dead; otherwise, false.

Gets a value indicating whether this is alive.

true if this is alive; otherwise, false.

Gets the current model of this entity

Gets the current network owner of this entity

Gets or sets the position of this .

The position in world space.

Sets the position of this without any offset.

The position in world space.

Gets or sets the rotation of this .

The yaw, pitch, roll rotation values.

Gets or sets the quaternion of this .

Gets or sets the heading of this .

The heading in degrees.

Gets the vector that points above this

Gets the vector that points to the right of this

Gets the vector that points in front of this

Gets this 's matrix which stores position and rotation information.

Gets or sets a value indicating whether this is frozen.

true if this is position frozen; otherwise, false.

Gets or sets the velocity of this .

Gets the rotation velocity of this .

Sets the maximum speed this can move at.

Gets or sets a value indicating whether this has gravity.

true if this has gravity; otherwise, false.

Gets how high above ground this is.

Gets a value indicating how submersed this is, 1.0f means the whole entity is submerged.

Gets or sets the level of detail distance of this .

Gets or sets a value indicating whether this is visible.

true if this is visible; otherwise, false.

Gets a value indicating whether this is occluded.

true if this is occluded; otherwise, false.

Gets a value indicating whether this is on screen.

true if this is on screen; otherwise, false.

Gets a value indicating whether this is rendered.

true if this is rendered; otherwise, false.

Gets a value indicating whether this is upright.

true if this is upright; otherwise, false.

Gets a value indicating whether this is upside down.

true if this is upside down; otherwise, false.

Gets a value indicating whether this is in the air.

true if this is in the air; otherwise, false.

Gets a value indicating whether this is in water.

true if this is in water; otherwise, false.

Gets or sets a value indicating whether this is persistent.

true if this is persistent; otherwise, false.

Gets a value indicating whether this is on fire.

true if this is on fire; otherwise, false.

Gets or sets a value indicating whether this is fire proof.

true if this is fire proof; otherwise, false.

Gets or sets a value indicating whether this is melee proof.

true if this is melee proof; otherwise, false.

Gets or sets a value indicating whether this is bullet proof.

true if this is bullet proof; otherwise, false.

Gets or sets a value indicating whether this is explosion proof.

true if this is explosion proof; otherwise, false.

Gets or sets a value indicating whether this is collision proof.

true if this is collision proof; otherwise, false.

Gets or sets a value indicating whether this is invincible.

true if this is invincible; otherwise, false.

Gets or sets a value indicating whether this can only be damaged by s.

true if this can only be damaged by s; otherwise, false.

Gets or sets how opacque this is.

0 for completely see through, 255 for fully opacque

Resets the opacity, .

Gets a value indicating whether this has collided with anything.

true if this has collided; otherwise, false. must be true for this to work.

Gets the material this entity is currently brushing up against. Only works for the material the entity is facing towards.

Gets or sets a value indicating whether this has collision.

true if this has collision; otherwise, false.

Gets or sets a value indicating whether this is recording collisions.

Sets the collision between this and another

The to set collision with if set to true the 2 s wont collide with each other.

Determines whether this has been damaged by a specified .

The to check true if this has been damaged by the specified ; otherwise, false.

Determines whether this has been damaged by a specific weapon].

The weapon to check. true if this has been damaged by the specified weapon; otherwise, false.

Determines whether this has been damaged by any weapon.

true if this has been damaged by any weapon; otherwise, false.

Determines whether this has been damaged by any melee weapon.

true if this has been damaged by any melee weapon; otherwise, false.

Clears the last weapon damage this received.

Determines whether this is in a specified area

The minimum bounds. The maximum bounds. true if this is in the specified area; otherwise, false.

Determines whether this is in a specified angled area

The origin. The edge. The angle. true if this is in the specified angled area; otherwise, false.

Determines whether this is in range of a specified position

The position. The maximum range. true if this is in range of the ; otherwise, false.

Determines whether this is near a specified .

The to check. The max displacement from the . true if this is near the ; otherwise, false.

Determines whether this is touching an with the .

The to check true if this is touching a ; otherwise, false.

Determines whether this is touching the .

The to check. true if this is touching ; otherwise, false.

Gets the position in world coords of an offset relative this

The offset from this .

Gets the relative offset of this from a world coords position

The world coords.

Gets a collection of the s in this

Creates a on this

Gets the attached to this

returns null if no s are attached to this

Gets an array of all s attached to this .

Attaches this to a different

The to attach this to. The position relative to the to attach this to. The rotation to apply to this relative to the

Attaches this to a different

The to attach this to. The position relative to the to attach this to. The rotation to apply to this relative to the

Detaches this from any it may be attached to.

Determines whether this is attached to any other .

true if this is attached to another ; otherwise, false.

Determines whether this is attached to the specified .

The to check if this is attached to. true if this is attached to ; otherwise, false.

Gets the this is attached to. returns null if this isnt attached to any entity

Applies a force to this .

The direction to apply the force relative to world coords. The rotation force to apply Type of the force to apply.

Applies a force to this .

The direction to apply the force relative to this s rotation The rotation force to apply Type of the force to apply.

Stops all particle effects attached to this

Gets the network ID of this

Deletes this

Marks this as no longer needed letting the game delete it when its too far away.

Gets the of this

Creates a new instance of an from the given handle.

The entity handle. Returns a if this handle corresponds to a Ped. Returns a if this handle corresponds to a Vehicle. Returns a if this handle corresponds to a Prop. Returns null if no exists this the specified

Creates a new instance of an from the given network ID.

The network ID of the entity. Returns a if this network ID corresponds to a Ped. Returns a if this network ID corresponds to a Vehicle. Returns a if this network ID corresponds to a Prop. Returns null if no exists for the specified

Determines whether this exists.

true if this exists; otherwise, false

Determines whether the exists.

The to check. true if the exists; otherwise, false

Checks if two s refer to the same

The other . true if they are the same ; otherwise, false

Gets the bone index of this .

Gets the position of this in world coords.

Determines if this is valid

true if this is valid; otherwise, false.

Checks if two s refer to the same

The other . true if they are the same bone of the same ; otherwise, false

Gets the with the specified bone name.

Name of the bone.

Gets the at the specified bone index.

The bone index.

Determines whether this has a bone with the specified bone name

Name of the bone. true if this has a bone with the specified bone name; otherwise, false.

Gets the number of bones that this has.

Gets a ActivePose Helper class for sending ActivePose to this

Gets a ApplyImpulse Helper class for sending ApplyImpulse to this

Gets a ApplyBulletImpulse Helper class for sending ApplyBulletImpulse to this

Gets a BodyRelax Helper class for sending BodyRelax to this

Set the amount of relaxation across the whole body; Used to collapse the character into a rag-doll-like state.

Gets a ConfigureBalance Helper class for sending ConfigureBalance to this

This single message allows you to configure various parameters used on any behaviour that uses the dynamic balance.

Gets a ConfigureBalanceReset Helper class for sending ConfigureBalanceReset to this

reset the values configurable by the Configure Balance message to their defaults.

Gets a ConfigureSelfAvoidance Helper class for sending ConfigureSelfAvoidance to this

this single message allows to configure self avoidance for the character.BBDD Self avoidance tech.

Gets a ConfigureBullets Helper class for sending ConfigureBullets to this

Gets a ConfigureBulletsExtra Helper class for sending ConfigureBulletsExtra to this

Gets a ConfigureLimits Helper class for sending ConfigureLimits to this

Enable/disable/edit character limits in real time. This adjusts limits in RAGE-native space and will *not* reorient the joint.

Gets a ConfigureSoftLimit Helper class for sending ConfigureSoftLimit to this

Gets a ConfigureShotInjuredArm Helper class for sending ConfigureShotInjuredArm to this

This single message allows you to configure the injured arm reaction during shot

Gets a ConfigureShotInjuredLeg Helper class for sending ConfigureShotInjuredLeg to this

This single message allows you to configure the injured leg reaction during shot

Gets a DefineAttachedObject Helper class for sending DefineAttachedObject to this

Gets a ForceToBodyPart Helper class for sending ForceToBodyPart to this

Apply an impulse to a named body part

Gets a LeanInDirection Helper class for sending LeanInDirection to this

Gets a LeanRandom Helper class for sending LeanRandom to this

Gets a LeanToPosition Helper class for sending LeanToPosition to this

Gets a LeanTowardsObject Helper class for sending LeanTowardsObject to this

Gets a HipsLeanInDirection Helper class for sending HipsLeanInDirection to this

Gets a HipsLeanRandom Helper class for sending HipsLeanRandom to this

Gets a HipsLeanToPosition Helper class for sending HipsLeanToPosition to this

Gets a HipsLeanTowardsObject Helper class for sending HipsLeanTowardsObject to this

Gets a ForceLeanInDirection Helper class for sending ForceLeanInDirection to this

Gets a ForceLeanRandom Helper class for sending ForceLeanRandom to this

Gets a ForceLeanToPosition Helper class for sending ForceLeanToPosition to this

Gets a ForceLeanTowardsObject Helper class for sending ForceLeanTowardsObject to this

Gets a SetStiffness Helper class for sending SetStiffness to this

Use this message to manually set the body stiffness values -before using Active Pose to drive to an animated pose, for example.

Gets a SetMuscleStiffness Helper class for sending SetMuscleStiffness to this

Use this message to manually set the muscle stiffness values -before using Active Pose to drive to an animated pose, for example.

Gets a SetWeaponMode Helper class for sending SetWeaponMode to this

Use this message to set the character's weapon mode. This is an alternativeto the setWeaponMode public function.

Gets a RegisterWeapon Helper class for sending RegisterWeapon to this

Use this message to register weapon. This is an alternativeto the registerWeapon public function.

Gets a ShotRelax Helper class for sending ShotRelax to this

Gets a FireWeapon Helper class for sending FireWeapon to this

One shot message apply a force to the hand as we fire the gun that should be in this hand

Gets a ConfigureConstraints Helper class for sending ConfigureConstraints to this

One shot to give state of constraints on character and response to constraints

Gets a StayUpright Helper class for sending StayUpright to this

Gets a StopAllBehaviours Helper class for sending StopAllBehaviours to this

Send this message to immediately stop all behaviours from executing.

Gets a SetCharacterStrength Helper class for sending SetCharacterStrength to this

Sets character's strength on the dead-granny-to-healthy-terminator scale: [0..1]

Gets a SetCharacterHealth Helper class for sending SetCharacterHealth to this

Sets character's health on the dead-to-alive scale: [0..1]

Gets a SetFallingReaction Helper class for sending SetFallingReaction to this

Sets the type of reaction if catchFall is called

Gets a SetCharacterUnderwater Helper class for sending SetCharacterUnderwater to this

Sets viscosity applied to damping limbs

Gets a SetCharacterCollisions Helper class for sending SetCharacterCollisions to this

setCharacterCollisions:

Gets a SetCharacterDamping Helper class for sending SetCharacterDamping to this

Damp out cartwheeling and somersaulting above a certain threshold

Gets a SetFrictionScale Helper class for sending SetFrictionScale to this

setFrictionScale:

Gets a AnimPose Helper class for sending AnimPose to this

Gets a ArmsWindmill Helper class for sending ArmsWindmill to this

Gets a ArmsWindmillAdaptive Helper class for sending ArmsWindmillAdaptive to this

Gets a BalancerCollisionsReaction Helper class for sending BalancerCollisionsReaction to this

Gets a BodyBalance Helper class for sending BodyBalance to this

Gets a BodyFoetal Helper class for sending BodyFoetal to this

Gets a BodyRollUp Helper class for sending BodyRollUp to this

Gets a BodyWrithe Helper class for sending BodyWrithe to this

Gets a BraceForImpact Helper class for sending BraceForImpact to this

Gets a Buoyancy Helper class for sending Buoyancy to this

Simple buoyancy model. No character movement just fluid forces/torques added to parts.

Gets a CatchFall Helper class for sending CatchFall to this

Gets a Electrocute Helper class for sending Electrocute to this

Gets a FallOverWall Helper class for sending FallOverWall to this

Gets a Grab Helper class for sending Grab to this

Gets a HeadLook Helper class for sending HeadLook to this

Gets a HighFall Helper class for sending HighFall to this

Gets a IncomingTransforms Helper class for sending IncomingTransforms to this

Gets a InjuredOnGround Helper class for sending InjuredOnGround to this

InjuredOnGround

Gets a Carried Helper class for sending Carried to this

Carried

Gets a Dangle Helper class for sending Dangle to this

Dangle

Gets a OnFire Helper class for sending OnFire to this

Gets a PedalLegs Helper class for sending PedalLegs to this

Gets a PointArm Helper class for sending PointArm to this

BEHAVIOURS REFERENCED: AnimPose - allows animPose to overridebodyParts: Arms (useLeftArm, useRightArm)

Gets a PointGun Helper class for sending PointGun to this

Gets a PointGunExtra Helper class for sending PointGunExtra to this

Seldom set parameters for pointGun - just to keep number of parameters in any message less than or equal to 64

Gets a RollDownStairs Helper class for sending RollDownStairs to this

Gets a Shot Helper class for sending Shot to this

Gets a ShotNewBullet Helper class for sending ShotNewBullet to this

Send new wound information to the shot. Can cause shot to restart it's performance in part or in whole.

Gets a ShotSnap Helper class for sending ShotSnap to this

Gets a ShotShockSpin Helper class for sending ShotShockSpin to this

configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces

Gets a ShotFallToKnees Helper class for sending ShotFallToKnees to this

configure the fall to knees shot.

Gets a ShotFromBehind Helper class for sending ShotFromBehind to this

configure the shot from behind reaction

Gets a ShotInGuts Helper class for sending ShotInGuts to this

configure the shot in guts reaction

Gets a ShotHeadLook Helper class for sending ShotHeadLook to this

Gets a ShotConfigureArms Helper class for sending ShotConfigureArms to this

configure the arm reactions in shot

Gets a SmartFall Helper class for sending SmartFall to this

Clone of High Fall with a wider range of operating conditions.

Gets a StaggerFall Helper class for sending StaggerFall to this

Gets a Teeter Helper class for sending Teeter to this

Gets a UpperBodyFlinch Helper class for sending UpperBodyFlinch to this

Gets a Yanked Helper class for sending Yanked to this

A Base class for manually building a

Creates a class to manually build s that can be sent to any .

The name of the natual motion message.

Stops this Natural Motion behavious on the given

The to send the Abort to.

Starts this Natural Motion behaviour on the that will loop until manually aborted

The to send the to.

Starts this Natural Motion behaviour on the for a specified duration.

The to send the to. How long to apply the behaviour for (-1 for looped).

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Resets all arguments to their default value's

A Helper class for building a and sending it to a given

Creates a Helper class for building Natural Motion messages to send to a given

The that the message will be applied to. The name of the natual motion message.

Starts this Natural Motion behaviour on the that will loop until manually aborted

Starts this Natural Motion behaviour on the for a specified duration.

How long to apply the behaviour for (-1 for looped).

Stops this Natural Motion behavious on the

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Sets a argument to a value

The argument name. The value to set the argument to.

Resets all arguments to their default value's

Creates a new Instance of the ActivePoseHelper for sending a ActivePose to a given .

The to send the ActivePose to.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see notes for explanation).

Default value = fb.

Sets the UseGravityCompensation setting for this . Apply gravity compensation as well?.

Default value = False.

Sets the AnimSource setting for this .

Creates a new Instance of the ApplyImpulseHelper for sending a ApplyImpulse to a given .

The to send the ApplyImpulse to.

Sets the EqualizeAmount setting for this . 0 means straight impulse, 1 means multiply by the mass (change in velocity).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the PartIndex setting for this . index of part being hit. -1 apply impulse to COM.

Default value = 0. Min value = -1. Max value = 28.

Sets the Impulse setting for this . impulse vector (impulse is change in momentum).

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -4500.0f. Max value = 4500.0f.

Sets the HitPoint setting for this . optional point on part where hit. If not supplied then the impulse is applied at the part centre.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the LocalHitPointInfo setting for this . hitPoint in local coordinates of bodyPart.

Default value = False.

Sets the LocalImpulseInfo setting for this . impulse in local coordinates of bodyPart.

Default value = False.

Sets the AngularImpulse setting for this . impulse should be considered an angular impulse.

Default value = False.

Creates a new Instance of the ApplyBulletImpulseHelper for sending a ApplyBulletImpulse to a given .

The to send the ApplyBulletImpulse to.

Sets the EqualizeAmount setting for this . 0 means straight impulse, 1 means multiply by the mass (change in velocity).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the PartIndex setting for this . index of part being hit.

Default value = 0. Min value = 0. Max value = 28.

Sets the Impulse setting for this . impulse vector (impulse is change in momentum).

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1000.0f. Max value = 1000.0f.

Sets the HitPoint setting for this . optional point on part where hit.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the LocalHitPointInfo setting for this . true = hitPoint is in local coordinates of bodyPart, false = hitpoint is in world coordinates.

Default value = False.

Sets the ExtraShare setting for this . if not 0.0 then have an extra bullet applied to spine0 (approximates the COM). Uses setup from configureBulletsExtra. 0-1 shared 0.0 = no extra bullet, 0.5 = impulse split equally between extra and bullet, 1.0 only extra bullet. LT 0.0 then bullet + scaled extra bullet. Eg.-0.5 = bullet + 0.5 impulse extra bullet.

Default value = 0.0f. Min value = -2.0f. Max value = 1.0f.

Set the amount of relaxation across the whole body; Used to collapse the character into a rag-doll-like state.

Creates a new Instance of the BodyRelaxHelper for sending a BodyRelax to a given .

The to send the BodyRelax to. Set the amount of relaxation across the whole body; Used to collapse the character into a rag-doll-like state.

Sets the Relaxation setting for this . How relaxed the body becomes, in percentage relaxed. 100 being totally rag-dolled, 0 being very stiff and rigid.

Default value = 50.0f. Min value = 0.0f. Max value = 100.0f.

Sets the Damping setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Sets the HoldPose setting for this . automatically hold the current pose as the character relaxes - can be used to avoid relaxing into a t-pose.

Default value = False.

Sets the DisableJointDriving setting for this . sets the drive state to free - this reduces drifting on the ground.

Default value = False.

This single message allows you to configure various parameters used on any behaviour that uses the dynamic balance.

Creates a new Instance of the ConfigureBalanceHelper for sending a ConfigureBalance to a given .

The to send the ConfigureBalance to. This single message allows you to configure various parameters used on any behaviour that uses the dynamic balance.

Sets the StepHeight setting for this . maximum height that character steps vertically (above 0.2 is high...but ok for say underwater).

Default value = 0.1f. Min value = 0.0f. Max value = 0.4f.

Sets the StepHeightInc4Step setting for this . added to stepHeight if going up steps.

Default value = 0.1f. Min value = 0.0f. Max value = 0.4f.

Sets the LegsApartRestep setting for this . if the legs end up more than (legsApartRestep + hipwidth) apart even though balanced, take another step.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the LegsTogetherRestep setting for this . mmmm0.1 for drunk if the legs end up less than (hipwidth - legsTogetherRestep) apart even though balanced, take another step. A value of 1 will turn off this feature and the max value is hipWidth = 0.23f by default but is model dependent.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LegsApartMax setting for this . FRICTION WORKAROUND: if the legs end up more than (legsApartMax + hipwidth) apart when balanced, adjust the feet positions to slide back so they are legsApartMax + hipwidth apart. Needs to be less than legsApartRestep to see any effect.

Default value = 2.0f. Min value = 0.0f. Max value = 2.0f.

Sets the TaperKneeStrength setting for this . does the knee strength reduce with angle.

Default value = True.

Sets the LegStiffness setting for this . stiffness of legs.

Default value = 12.0f. Min value = 6.0f. Max value = 16.0f.

Sets the LeftLegSwingDamping setting for this . damping of left leg during swing phase (mmmmDrunk used 1.25 to slow legs movement).

Default value = 1.0f. Min value = 0.2f. Max value = 4.0f.

Sets the RightLegSwingDamping setting for this . damping of right leg during swing phase (mmmmDrunk used 1.25 to slow legs movement).

Default value = 1.0f. Min value = 0.2f. Max value = 4.0f.

Sets the OpposeGravityLegs setting for this . Gravity opposition applied to hips and knees.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the OpposeGravityAnkles setting for this . Gravity opposition applied to ankles. General balancer likes 1.0. StaggerFall likes 0.1.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the LeanAcc setting for this . Multiplier on the floorAcceleration added to the lean.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the HipLeanAcc setting for this . Multiplier on the floorAcceleration added to the leanHips.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the LeanAccMax setting for this . Max floorAcceleration allowed for lean and leanHips.

Default value = 5.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ResistAcc setting for this . Level of cheat force added to character to resist the effect of floorAcceleration (anti-Acceleration) - added to upperbody.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the ResistAccMax setting for this . Max floorAcceleration allowed for anti-Acceleration. If GT 20.0 then it is probably in a crash.

Default value = 3.0f. Min value = 0.0f. Max value = 20.0f.

Sets the FootSlipCompOnMovingFloor setting for this . This parameter will be removed when footSlipCompensation preserves the foot angle on a moving floor]. If the character detects a moving floor and footSlipCompOnMovingFloor is false then it will turn off footSlipCompensation - at footSlipCompensation preserves the global heading of the feet. If footSlipCompensation is off then the character usually turns to the side in the end although when turning the vehicle turns it looks promising for a while.

Default value = True.

Sets the AnkleEquilibrium setting for this . ankle equilibrium angle used when static balancing.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the ExtraFeetApart setting for this . additional feet apart setting.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the DontStepTime setting for this . amount of time at the start of a balance before the character is allowed to start stepping.

Default value = 0.0f. Min value = 0.0f.

Sets the BalanceAbortThreshold setting for this . when the character gives up and goes into a fall. Larger values mean that the balancer can lean more before failing.

Default value = 0.6f. Min value = 0.0f. Max value = 1.0f.

Sets the GiveUpHeight setting for this . height between lowest foot and COM below which balancer will give up.

Default value = 0.5f. Min value = 0.0f. Max value = 1.5f.

Sets the StepClampScale setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the StepClampScaleVariance setting for this . Variance in clamp scale every step. if negative only takes away from clampScale.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the PredictionTimeHip setting for this . amount of time (seconds) into the future that the character tries to move hip to (kind of). Will be controlled by balancer in future but can help recover spine quicker from bending forwards to much.

Default value = 0.3f. Min value = -1.0f. Max value = 1.0f.

Sets the PredictionTime setting for this . amount of time (seconds) into the future that the character tries to step to. bigger values try to recover with fewer, bigger steps. smaller values recover with smaller steps, and generally recover less.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the PredictionTimeVariance setting for this . Variance in predictionTime every step. if negative only takes away from predictionTime.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the MaxSteps setting for this . Maximum number of steps that the balancer will take.

Default value = 100. Min value = 1.

Sets the MaxBalanceTime setting for this . Maximum time(seconds) that the balancer will balance for.

Default value = 50.0f. Min value = 1.0f.

Sets the ExtraSteps setting for this . Allow the balancer to take this many more steps before hitting maxSteps. If negative nothing happens(safe default).

Default value = -1. Min value = -1.

Sets the ExtraTime setting for this . Allow the balancer to balance for this many more seconds before hitting maxBalanceTime. If negative nothing happens(safe default).

Default value = -1.0f. Min value = -1.0f.

Sets the FallType setting for this . How to fall after maxSteps or maxBalanceTime.

Default value = . If BCR has to be active.

Sets the FallMult setting for this . Multiply the rampDown of stiffness on falling by this amount ( GT 1 fall quicker).

Default value = 1.0f. Min value = 0.0f. Max value = 100.0f.

Sets the FallReduceGravityComp setting for this . Reduce gravity compensation as the legs weaken on falling.

Default value = False.

Sets the RampHipPitchOnFail setting for this . bend over when falling after maxBalanceTime.

Default value = False.

Sets the StableLinSpeedThresh setting for this . Linear speed threshold for successful balance.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the StableRotSpeedThresh setting for this . Rotational speed threshold for successful balance.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the FailMustCollide setting for this . The upper body of the character must be colliding and other failure conditions met to fail.

Default value = False.

Sets the IgnoreFailure setting for this . Ignore maxSteps and maxBalanceTime and try to balance forever.

Default value = False.

Sets the ChangeStepTime setting for this . time not in contact (airborne) before step is changed. If -ve don't change step.

Default value = -1.0f. Min value = -1.0f. Max value = 5.0f.

Sets the BalanceIndefinitely setting for this . Ignore maxSteps and maxBalanceTime and try to balance forever.

Default value = False.

Sets the MovingFloor setting for this . temporary variable to ignore movingFloor code that generally causes the character to fall over if the feet probe a moving object e.g. treading on a gun.

Default value = False.

Sets the AirborneStep setting for this . when airborne try to step. Set to false for e.g. shotGun reaction.

Default value = True.

Sets the UseComDirTurnVelThresh setting for this . Velocity below which the balancer turns in the direction of the COM forward instead of the ComVel - for use with shot from running with high upright constraint use 1.9.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the MinKneeAngle setting for this . Minimum knee angle (-ve value will mean this functionality is not applied). 0.4 seems a good value.

Default value = -0.5f. Min value = -0.5f. Max value = 1.5f.

Sets the FlatterSwingFeet setting for this .

Default value = False.

Sets the FlatterStaticFeet setting for this .

Default value = False.

Sets the AvoidLeg setting for this . If true then balancer tries to avoid leg2leg collisions/avoid crossing legs. Avoid tries to not step across a line of the inside of the stance leg's foot.

Default value = False.

Sets the AvoidFootWidth setting for this . NB. Very sensitive. Avoid tries to not step across a line of the inside of the stance leg's foot. avoidFootWidth = how much inwards from the ankle this line is in (m).

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the AvoidFeedback setting for this . NB. Very sensitive. Avoid tries to not step across a line of the inside of the stance leg's foot. Avoid doesn't allow the desired stepping foot to cross the line. avoidFeedback = how much of the actual crossing of that line is fedback as an error.

Default value = 0.6f. Min value = 0.0f. Max value = 2.0f.

Sets the LeanAgainstVelocity setting for this .

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the StepDecisionThreshold setting for this .

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the StepIfInSupport setting for this . The balancer sometimes decides to step even if balanced.

Default value = True.

Sets the AlwaysStepWithFarthest setting for this .

Default value = False.

Sets the StandUp setting for this . standup more with increased velocity.

Default value = False.

Sets the DepthFudge setting for this . Supposed to increase foot friction: Impact depth of a collision with the foot is changed when the balancer is running - impact.SetDepth(impact.GetDepth() - depthFudge).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the DepthFudgeStagger setting for this . Supposed to increase foot friction: Impact depth of a collision with the foot is changed when staggerFall is running - impact.SetDepth(impact.GetDepth() - depthFudgeStagger).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the FootFriction setting for this . Foot friction multiplier is multiplied by this amount if balancer is running.

Default value = 1.0f. Min value = 0.0f. Max value = 40.0f.

Sets the FootFrictionStagger setting for this . Foot friction multiplier is multiplied by this amount if staggerFall is running.

Default value = 1.0f. Min value = 0.0f. Max value = 40.0f.

Sets the BackwardsLeanCutoff setting for this . Backwards lean threshold to cut off stay upright forces. 0.0 Vertical - 1.0 horizontal. 0.6 is a sensible value. NB: the balancer does not fail in order to give stagger that extra step as it falls. A backwards lean of GT 0.6 will generally mean the balancer will soon fail without stayUpright forces.

Default value = 1.1f. Min value = 0.0f. Max value = 2.0f.

Sets the GiveUpHeightEnd setting for this . if this value is different from giveUpHeight, actual giveUpHeight will be ramped toward this value.

Default value = 0.5f. Min value = 0.0f. Max value = 1.5f.

Sets the BalanceAbortThresholdEnd setting for this . if this value is different from balanceAbortThreshold, actual balanceAbortThreshold will be ramped toward this value.

Default value = 0.6f. Min value = 0.0f. Max value = 1.0f.

Sets the GiveUpRampDuration setting for this . duration of ramp from start of behaviour for above two parameters. If smaller than 0, no ramp is applied.

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Sets the LeanToAbort setting for this . lean at which to send abort message when maxSteps or maxBalanceTime is reached.

Default value = 0.6f. Min value = 0.0f. Max value = 1.0f.

reset the values configurable by the Configure Balance message to their defaults.

Creates a new Instance of the ConfigureBalanceResetHelper for sending a ConfigureBalanceReset to a given .

The to send the ConfigureBalanceReset to. reset the values configurable by the Configure Balance message to their defaults.

this single message allows to configure self avoidance for the character.BBDD Self avoidance tech.

Creates a new Instance of the ConfigureSelfAvoidanceHelper for sending a ConfigureSelfAvoidance to a given .

The to send the ConfigureSelfAvoidance to. this single message allows to configure self avoidance for the character.BBDD Self avoidance tech.

Sets the UseSelfAvoidance setting for this . Enable or disable self avoidance tech.

Default value = False.

Sets the OverwriteDragReduction setting for this . Specify whether self avoidance tech should use original IK input target or the target that has been already modified by getStabilisedPos() tech i.e. function that compensates for rotational and linear velocity of shoulder/thigh.

Default value = False.

Sets the TorsoSwingFraction setting for this . Place the adjusted target this much along the arc between effector (wrist) and target, value in range [0,1].

Default value = 0.8f. Min value = 0.0f. Max value = 1.0f.

Sets the MaxTorsoSwingAngleRad setting for this . Max value on the effector (wrist) to adjusted target offset.

Default value = 0.8f. Min value = 0.0f. Max value = 1.6f.

Sets the SelfAvoidIfInSpineBoundsOnly setting for this . Restrict self avoidance to operate on targets that are within character torso bounds only.

Default value = False.

Sets the SelfAvoidAmount setting for this . Amount of self avoidance offset applied when angle from effector (wrist) to target is greater then right angle i.e. when total offset is a blend between where effector currently is to value that is a product of total arm length and selfAvoidAmount. SelfAvoidAmount is in a range between [0, 1].

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the OverwriteTwist setting for this . Overwrite desired IK twist with self avoidance procedural twist.

Default value = False.

Sets the UsePolarPathAlgorithm setting for this . Use the alternative self avoidance algorithm that is based on linear and polar target blending. WARNING: It only requires "radius" in terms of parametrization.

Default value = False.

Sets the Radius setting for this . Self avoidance radius, measured out from the spine axis along the plane perpendicular to that axis. The closer is the proximity of reaching target to that radius, the more polar (curved) motion is used for offsetting the target. WARNING: Parameter only used by the alternative algorithm that is based on linear and polar target blending.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Creates a new Instance of the ConfigureBulletsHelper for sending a ConfigureBullets to a given .

The to send the ConfigureBullets to.

Sets the ImpulseSpreadOverParts setting for this . spreads impulse across parts. currently only for spine parts, not limbs.

Default value = False.

Sets the ImpulseLeakageStrengthScaled setting for this . for weaker characters subsequent impulses remain strong.

Default value = False.

Sets the ImpulsePeriod setting for this . duration that impulse is spread over (triangular shaped).

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseTorqueScale setting for this . An impulse applied at a point on a body equivalent to an impulse at the centre of the body and a torque. This parameter scales the torque component. (The torque component seems to be excite the rage looseness bug which sends the character in a sometimes wildly different direction to an applied impulse).

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LoosenessFix setting for this . Fix the rage looseness bug by applying only the impulse at the centre of the body unless it is a spine part then apply the twist component only of the torque as well.

Default value = False.

Sets the ImpulseDelay setting for this . time from hit before impulses are being applied.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseReductionPerShot setting for this . by how much are subsequent impulses reduced (e.g. 0.0: no reduction, 0.1: 10% reduction each new hit).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseRecovery setting for this . recovery rate of impulse strength per second (impulse strength from 0.0:1.0). At 60fps a impulseRecovery=60.0 will recover in 1 frame.

Default value = 0.0f. Min value = 0.0f. Max value = 60.0f.

Sets the ImpulseMinLeakage setting for this . the minimum amount of impulse leakage allowed.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the TorqueMode setting for this .

Default value = . If - proportional to character strength, can reduce impulse amount. If - no reduction of impulse and not proportional to character strength.

Sets the TorqueSpinMode setting for this .

Default value = . If a burst effect is achieved.

Sets the TorqueFilterMode setting for this .

Default value = .

Sets the TorqueAlwaysSpine3 setting for this . always apply torques to spine3 instead of actual part hit.

Default value = True.

Sets the TorqueDelay setting for this . time from hit before torques are being applied.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TorquePeriod setting for this . duration of torque.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the TorqueGain setting for this . multiplies impulse magnitude to arrive at torque that is applied.

Default value = 4.0f. Min value = 0.0f. Max value = 10.0f.

Sets the TorqueCutoff setting for this . minimum ratio of impulse that remains after converting to torque (if in strength-proportional mode).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TorqueReductionPerTick setting for this . ratio of torque for next tick (e.g. 1.0: not reducing over time, 0.9: each tick torque is reduced by 10%).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LiftGain setting for this . amount of lift (directly multiplies torque axis to give lift force).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the CounterImpulseDelay setting for this . time after impulse is applied that counter impulse is applied.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the CounterImpulseMag setting for this . amount of the original impulse that is countered.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the CounterAfterMagReached setting for this . applies the counter impulse counterImpulseDelay(secs) after counterImpulseMag of the Impulse has been applied.

Default value = False.

Sets the DoCounterImpulse setting for this . add a counter impulse to the pelvis.

Default value = False.

Sets the CounterImpulse2Hips setting for this . amount of the counter impulse applied to hips - the rest is applied to the part originally hit.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseNoBalMult setting for this . amount to scale impulse by if the dynamicBalance is not OK. 1.0 means this functionality is not applied.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseBalStabStart setting for this . 100% LE Start to impulseBalStabMult*100% GT End. NB: Start LT End.

Default value = 3.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseBalStabEnd setting for this . 100% LE Start to impulseBalStabMult*100% GT End. NB: Start LT End.

Default value = 10.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseBalStabMult setting for this . 100% LE Start to impulseBalStabMult*100% GT End. NB: leaving this as 1.0 means this functionality is not applied and Start and End have no effect.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseSpineAngStart setting for this . 100% GE Start to impulseSpineAngMult*100% LT End. NB: Start GT End. This the dot of hip2Head with up.

Default value = 0.7f. Min value = -1.0f. Max value = 1.0f.

Sets the ImpulseSpineAngEnd setting for this . 100% GE Start to impulseSpineAngMult*100% LT End. NB: Start GT End. This the dot of hip2Head with up.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the ImpulseSpineAngMult setting for this . 100% GE Start to impulseSpineAngMult*100% LT End. NB: leaving this as 1.0 means this functionality is not applied and Start and End have no effect.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseVelStart setting for this . 100% LE Start to impulseVelMult*100% GT End. NB: Start LT End.

Default value = 1.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseVelEnd setting for this . 100% LE Start to impulseVelMult*100% GT End. NB: Start LT End.

Default value = 4.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseVelMult setting for this . 100% LE Start to impulseVelMult*100% GT End. NB: leaving this as 1.0 means this functionality is not applied and Start and End have no effect.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseAirMult setting for this . amount to scale impulse by if the character is airborne and dynamicBalance is OK and impulse is above impulseAirMultStart.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseAirMultStart setting for this . if impulse is above this value scale it by impulseAirMult.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseAirMax setting for this . amount to clamp impulse to if character is airborne and dynamicBalance is OK.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseAirApplyAbove setting for this . if impulse is above this amount then do not scale/clamp just let it through as is - it's a shotgun or cannon.

Default value = 399.0f. Min value = 0.0f.

Sets the ImpulseAirOn setting for this . scale and/or clamp impulse if the character is airborne and dynamicBalance is OK.

Default value = False.

Sets the ImpulseOneLegMult setting for this . amount to scale impulse by if the character is contacting with one foot only and dynamicBalance is OK and impulse is above impulseAirMultStart.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseOneLegMultStart setting for this . if impulse is above this value scale it by impulseOneLegMult.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseOneLegMax setting for this . amount to clamp impulse to if character is contacting with one foot only and dynamicBalance is OK.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseOneLegApplyAbove setting for this . if impulse is above this amount then do not scale/clamp just let it through as is - it's a shotgun or cannon.

Default value = 399.0f. Min value = 0.0f.

Sets the ImpulseOneLegOn setting for this . scale and/or clamp impulse if the character is contacting with one leg only and dynamicBalance is OK.

Default value = False.

Sets the RbRatio setting for this . 0.0 no rigidBody response, 0.5 half partForce half rigidBody, 1.0 = no partForce full rigidBody.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbLowerShare setting for this . rigid body response is shared between the upper and lower body (rbUpperShare = 1-rbLowerShare). rbLowerShare=0.5 gives upper and lower share scaled by mass. i.e. if 70% ub mass and 30% lower mass then rbLowerShare=0.5 gives actualrbShare of 0.7ub and 0.3lb. rbLowerShare GT 0.5 scales the ub share down from 0.7 and the lb up from 0.3.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMoment setting for this . 0.0 only force, 0.5 = force and half the rigid body moment applied, 1.0 = force and full rigidBody moment.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMaxTwistMomentArm setting for this . Maximum twist arm moment of bullet applied.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the RbMaxBroomMomentArm setting for this . Maximum broom((everything but the twist) arm moment of bullet applied.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the RbRatioAirborne setting for this . if Airborne: 0.0 no rigidBody response, 0.5 half partForce half rigidBody, 1.0 = no partForce full rigidBody.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMomentAirborne setting for this . if Airborne: 0.0 only force, 0.5 = force and half the rigid body moment applied, 1.0 = force and full rigidBody moment.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMaxTwistMomentArmAirborne setting for this . if Airborne: Maximum twist arm moment of bullet applied.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the RbMaxBroomMomentArmAirborne setting for this . if Airborne: Maximum broom((everything but the twist) arm moment of bullet applied.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the RbRatioOneLeg setting for this . if only one leg in contact: 0.0 no rigidBody response, 0.5 half partForce half rigidBody, 1.0 = no partForce full rigidBody.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMomentOneLeg setting for this . if only one leg in contact: 0.0 only force, 0.5 = force and half the rigid body moment applied, 1.0 = force and full rigidBody moment.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMaxTwistMomentArmOneLeg setting for this . if only one leg in contact: Maximum twist arm moment of bullet applied.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the RbMaxBroomMomentArmOneLeg setting for this . if only one leg in contact: Maximum broom((everything but the twist) arm moment of bullet applied.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the RbTwistAxis setting for this .

Default value = . .

Sets the RbPivot setting for this . if false pivot around COM always, if true change pivot depending on foot contact: to feet centre if both feet in contact, or foot position if 1 foot in contact or COM position if no feet in contact.

Default value = False.

Creates a new Instance of the ConfigureBulletsExtraHelper for sending a ConfigureBulletsExtra to a given .

The to send the ConfigureBulletsExtra to.

Sets the ImpulseSpreadOverParts setting for this . spreads impulse across parts. currently only for spine parts, not limbs.

Default value = False.

Sets the ImpulsePeriod setting for this . duration that impulse is spread over (triangular shaped).

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Default value = False.

Sets the ImpulseDelay setting for this . time from hit before impulses are being applied.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TorqueMode setting for this .

Default value = . If - proportional to character strength, can reduce impulse amount. If - no reduction of impulse and not proportional to character strength.

Sets the TorqueSpinMode setting for this .

Default value = . If a burst effect is achieved.

Sets the TorqueFilterMode setting for this .

Default value = .

Sets the TorqueAlwaysSpine3 setting for this . always apply torques to spine3 instead of actual part hit.

Default value = True.

Sets the TorqueDelay setting for this . time from hit before torques are being applied.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TorquePeriod setting for this . duration of torque.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the TorqueGain setting for this . multiplies impulse magnitude to arrive at torque that is applied.

Default value = 4.0f. Min value = 0.0f. Max value = 10.0f.

Sets the TorqueCutoff setting for this . minimum ratio of impulse that remains after converting to torque (if in strength-proportional mode).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TorqueReductionPerTick setting for this . ratio of torque for next tick (e.g. 1.0: not reducing over time, 0.9: each tick torque is reduced by 10%).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LiftGain setting for this . amount of lift (directly multiplies torque axis to give lift force).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the CounterImpulseDelay setting for this . time after impulse is applied that counter impulse is applied.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the CounterImpulseMag setting for this . amount of the original impulse that is countered.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the CounterAfterMagReached setting for this . applies the counter impulse counterImpulseDelay(secs) after counterImpulseMag of the Impulse has been applied.

Default value = False.

Sets the DoCounterImpulse setting for this . add a counter impulse to the pelvis.

Default value = False.

Sets the CounterImpulse2Hips setting for this . amount of the counter impulse applied to hips - the rest is applied to the part originally hit.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseNoBalMult setting for this . amount to scale impulse by if the dynamicBalance is not OK. 1.0 means this functionality is not applied.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseBalStabStart setting for this . 100% LE Start to impulseBalStabMult*100% GT End. NB: Start LT End.

Default value = 3.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseBalStabEnd setting for this . 100% LE Start to impulseBalStabMult*100% GT End. NB: Start LT End.

Default value = 10.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseBalStabMult setting for this . 100% LE Start to impulseBalStabMult*100% GT End. NB: leaving this as 1.0 means this functionality is not applied and Start and End have no effect.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseSpineAngStart setting for this . 100% GE Start to impulseSpineAngMult*100% LT End. NB: Start GT End. This the dot of hip2Head with up.

Default value = 0.7f. Min value = -1.0f. Max value = 1.0f.

Sets the ImpulseSpineAngEnd setting for this . 100% GE Start to impulseSpineAngMult*100% LT End. NB: Start GT End. This the dot of hip2Head with up.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the ImpulseSpineAngMult setting for this . 100% GE Start to impulseSpineAngMult*100% LT End. NB: leaving this as 1.0 means this functionality is not applied and Start and End have no effect.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseVelStart setting for this . 100% LE Start to impulseVelMult*100% GT End. NB: Start LT End.

Default value = 4.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseVelEnd setting for this . 100% LE Start to impulseVelMult*100% GT End. NB: Start LT End.

Default value = 4.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ImpulseVelMult setting for this . 100% LE Start to impulseVelMult*100% GT End. NB: leaving this as 1.0 means this functionality is not applied and Start and End have no effect.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseAirMult setting for this . amount to scale impulse by if the character is airborne and dynamicBalance is OK and impulse is above impulseAirMultStart.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseAirMultStart setting for this . if impulse is above this value scale it by impulseAirMult.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseAirMax setting for this . amount to clamp impulse to if character is airborne and dynamicBalance is OK.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseAirApplyAbove setting for this . if impulse is above this amount then do not scale/clamp just let it through as is - it's a shotgun or cannon.

Default value = 399.0f. Min value = 0.0f.

Sets the ImpulseAirOn setting for this . scale and/or clamp impulse if the character is airborne and dynamicBalance is OK.

Default value = False.

Sets the ImpulseOneLegMult setting for this . amount to scale impulse by if the character is contacting with one foot only and dynamicBalance is OK and impulse is above impulseAirMultStart.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ImpulseOneLegMultStart setting for this . if impulse is above this value scale it by impulseOneLegMult.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseOneLegMax setting for this . amount to clamp impulse to if character is contacting with one foot only and dynamicBalance is OK.

Default value = 100.0f. Min value = 0.0f.

Sets the ImpulseOneLegApplyAbove setting for this . if impulse is above this amount then do not scale/clamp just let it through as is - it's a shotgun or cannon.

Default value = 399.0f. Min value = 0.0f.

Sets the ImpulseOneLegOn setting for this . scale and/or clamp impulse if the character is contacting with one leg only and dynamicBalance is OK.

Default value = False.

Sets the RbRatio setting for this . 0.0 no rigidBody response, 0.5 half partForce half rigidBody, 1.0 = no partForce full rigidBody.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMoment setting for this . 0.0 only force, 0.5 = force and half the rigid body moment applied, 1.0 = force and full rigidBody moment.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMaxTwistMomentArm setting for this . Maximum twist arm moment of bullet applied.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the RbMaxBroomMomentArm setting for this . Maximum broom((everything but the twist) arm moment of bullet applied.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the RbRatioAirborne setting for this . if Airborne: 0.0 no rigidBody response, 0.5 half partForce half rigidBody, 1.0 = no partForce full rigidBody.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMomentAirborne setting for this . if Airborne: 0.0 only force, 0.5 = force and half the rigid body moment applied, 1.0 = force and full rigidBody moment.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMaxTwistMomentArmAirborne setting for this . if Airborne: Maximum twist arm moment of bullet applied.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the RbMaxBroomMomentArmAirborne setting for this . if Airborne: Maximum broom((everything but the twist) arm moment of bullet applied.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the RbRatioOneLeg setting for this . if only one leg in contact: 0.0 no rigidBody response, 0.5 half partForce half rigidBody, 1.0 = no partForce full rigidBody.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMomentOneLeg setting for this . if only one leg in contact: 0.0 only force, 0.5 = force and half the rigid body moment applied, 1.0 = force and full rigidBody moment.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RbMaxTwistMomentArmOneLeg setting for this . if only one leg in contact: Maximum twist arm moment of bullet applied.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the RbMaxBroomMomentArmOneLeg setting for this . if only one leg in contact: Maximum broom((everything but the twist) arm moment of bullet applied.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the RbTwistAxis setting for this .

Default value = . .

Default value = False.

Enable/disable/edit character limits in real time. This adjusts limits in RAGE-native space and will *not* reorient the joint.

Creates a new Instance of the ConfigureLimitsHelper for sending a ConfigureLimits to a given .

The to send the ConfigureLimits to. Enable/disable/edit character limits in real time. This adjusts limits in RAGE-native space and will *not* reorient the joint.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value for joint limits to configure. Ignored if index != -1.

Default value = fb.

Sets the Enable setting for this . If false, disable (set all to PI, -PI) limits.

Default value = True.

Sets the ToDesired setting for this . If true, set limits to accommodate current desired angles.

Default value = False.

Sets the Restore setting for this . Return to cached defaults?.

Default value = False.

Sets the ToCurAnimation setting for this . If true, set limits to the current animated limits.

Default value = False.

Sets the Index setting for this . Index of effector to configure. Set to -1 to use mask.

Default value = -1. Min value = -1.

Sets the Lean1 setting for this . Custom limit values to use if not setting limits to desired. Limits are RAGE-native, not NM-wrapper-native.

Default value = 1.6f. Min value = 0.0f. Max value = 3.1f.

Sets the Lean2 setting for this .

Default value = 1.6f. Min value = 0.0f. Max value = 3.1f.

Sets the Twist setting for this .

Default value = 1.6f. Min value = 0.0f. Max value = 3.1f.

Sets the Margin setting for this . Joint limit margin to add to current animation limits when using those to set runtime limits.

Default value = 0.2f. Min value = 0.0f. Max value = 3.1f.

Creates a new Instance of the ConfigureSoftLimitHelper for sending a ConfigureSoftLimit to a given .

The to send the ConfigureSoftLimit to.

Sets the Index setting for this . Select limb that the soft limit is going to be applied to.

Default value = 0. Min value = 0. Max value = 3.

Sets the Stiffness setting for this . Stiffness of the soft limit. Parameter is used to calculate spring term that contributes to the desired acceleration.

Default value = 15.0f. Min value = 0.0f. Max value = 30.0f.

Sets the Damping setting for this . Damping of the soft limit. Parameter is used to calculate damper term that contributes to the desired acceleration. To have the system critically dampened set it to 1.0.

Default value = 1.0f. Min value = 0.9f. Max value = 1.1f.

Sets the LimitAngle setting for this . Soft limit angle. Positive angle in RAD, measured relatively either from hard limit maxAngle (approach direction = -1) or minAngle (approach direction = 1). This angle will be clamped if outside the joint hard limit range.

Default value = 0.4f. Min value = 0.0f. Max value = 6.3f.

Sets the ApproachDirection setting for this . Limit angle can be measured relatively to joints hard limit minAngle or maxAngle. Set approachDirection to +1 to measure soft limit angle relatively to hard limit minAngle that corresponds to the maximum stretch of the elbow. Set it to -1 to measure soft limit angle relatively to hard limit maxAngle that corresponds to the maximum stretch of the knee.

Default value = 1. Min value = -1. Max value = 1.

Sets the VelocityScaled setting for this . Scale stiffness based on character angular velocity.

Default value = False.

This single message allows you to configure the injured arm reaction during shot.

Creates a new Instance of the ConfigureShotInjuredArmHelper for sending a ConfigureShotInjuredArm to a given .

The to send the ConfigureShotInjuredArm to. This single message allows you to configure the injured arm reaction during shot.

Sets the InjuredArmTime setting for this . length of the reaction.

Default value = 0.3f. Min value = 0.0f. Max value = 2.0f.

Sets the HipYaw setting for this . Amount of hip twist. (Negative values twist into bullet direction - probably not what is wanted).

Default value = 0.8f. Min value = -2.0f. Max value = 2.0f.

Sets the HipRoll setting for this . Amount of hip roll.

Default value = 0.0f. Min value = -2.0f. Max value = 2.0f.

Sets the ForceStepExtraHeight setting for this . Additional height added to stepping foot.

Default value = 0.1f. Min value = 0.0f. Max value = 0.7f.

Sets the ForceStep setting for this . force a step to be taken whether pushed out of balance or not.

Default value = True.

Sets the StepTurn setting for this . turn the character using the balancer.

Default value = True.

Sets the VelMultiplierStart setting for this . Start velocity where parameters begin to be ramped down to zero linearly.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the VelMultiplierEnd setting for this . End velocity of ramp where parameters are scaled to zero.

Default value = 5.0f. Min value = 1.0f. Max value = 40.0f.

Sets the VelForceStep setting for this . Velocity above which a step is not forced.

Default value = 0.8f. Min value = 0.0f. Max value = 20.0f.

Sets the VelStepTurn setting for this . Velocity above which a stepTurn is not asked for.

Default value = 0.8f. Min value = 0.0f. Max value = 20.0f.

Sets the VelScales setting for this . Use the velocity scaling parameters. Tune for standing still then use velocity scaling to make sure a running character stays balanced (the turning tends to make the character fall over more at speed).

Default value = True.

This single message allows you to configure the injured leg reaction during shot.

Creates a new Instance of the ConfigureShotInjuredLegHelper for sending a ConfigureShotInjuredLeg to a given .

The to send the ConfigureShotInjuredLeg to. This single message allows you to configure the injured leg reaction during shot.

Sets the TimeBeforeCollapseWoundLeg setting for this . time before a wounded leg is set to be weak and cause the character to collapse.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the LegInjuryTime setting for this . Leg inury duration (reaction to being shot in leg).

Default value = 0.4f. Min value = 0.0f. Max value = 2.0f.

Sets the LegForceStep setting for this . force a step to be taken whether pushed out of balance or not.

Default value = True.

Sets the LegLimpBend setting for this . Bend the legs via the balancer by this amount if stepping on the injured leg. 0.2 seems a good default.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LegLiftTime setting for this . Leg lift duration (reaction to being shot in leg) (lifting happens when not stepping with other leg).

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the LegInjury setting for this . Leg injury - leg strength is reduced.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the LegInjuryHipPitch setting for this . Leg injury bend forwards amount when not lifting leg.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the LegInjuryLiftHipPitch setting for this . Leg injury bend forwards amount when lifting leg (lifting happens when not stepping with other leg).

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the LegInjurySpineBend setting for this . Leg injury bend forwards amount when not lifting leg.

Default value = 0.1f. Min value = -1.0f. Max value = 1.0f.

Sets the LegInjuryLiftSpineBend setting for this . Leg injury bend forwards amount when lifting leg (lifting happens when not stepping with other leg).

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Creates a new Instance of the DefineAttachedObjectHelper for sending a DefineAttachedObject to a given .

The to send the DefineAttachedObject to.

Sets the PartIndex setting for this . index of part to attach to.

Default value = -1. Min value = -1. Max value = 21.

Sets the ObjectMass setting for this . mass of the attached object.

Default value = 0.0f. Min value = 0.0f.

Sets the WorldPos setting for this . world position of attached object's centre of mass. must be updated each frame.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Apply an impulse to a named body part.

Creates a new Instance of the ForceToBodyPartHelper for sending a ForceToBodyPart to a given .

The to send the ForceToBodyPart to. Apply an impulse to a named body part.

Sets the PartIndex setting for this . part or link or bound index.

Default value = 0. Min value = 0. Max value = 28.

Sets the Force setting for this . force to apply.

Default value = Vector3(0.0f, -50.0f, 0.0f). Min value = -100000.0f. Max value = 100000.0f.

Sets the ForceDefinedInPartSpace setting for this .

Default value = False.

Creates a new Instance of the LeanInDirectionHelper for sending a LeanInDirection to a given .

The to send the LeanInDirection to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the Dir setting for this . direction to lean in.

Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 0.0f.

Creates a new Instance of the LeanRandomHelper for sending a LeanRandom to a given .

The to send the LeanRandom to.

Sets the LeanAmountMin setting for this . minimum amount of lean.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the LeanAmountMax setting for this . maximum amount of lean.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the ChangeTimeMin setting for this . min time until changing direction.

Default value = 0.5f. Min value = 0.0f. Max value = 20.0f.

Sets the ChangeTimeMax setting for this . maximum time until changing direction.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Creates a new Instance of the LeanToPositionHelper for sending a LeanToPosition to a given .

The to send the LeanToPosition to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

Sets the Pos setting for this . position to head towards.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Creates a new Instance of the LeanTowardsObjectHelper for sending a LeanTowardsObject to a given .

The to send the LeanTowardsObject to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

Sets the Offset setting for this . offset from instance position added when calculating position to lean to.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -100.0f. Max value = 100.0f.

Sets the InstanceIndex setting for this . levelIndex of object to lean towards.

Default value = -1. Min value = -1.

Sets the BoundIndex setting for this . boundIndex of object to lean towards (0 = just use instance coordinates).

Default value = 0. Min value = 0.

Creates a new Instance of the HipsLeanInDirectionHelper for sending a HipsLeanInDirection to a given .

The to send the HipsLeanInDirection to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the Dir setting for this . direction to lean in.

Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 0.0f.

Creates a new Instance of the HipsLeanRandomHelper for sending a HipsLeanRandom to a given .

The to send the HipsLeanRandom to.

Sets the LeanAmountMin setting for this . minimum amount of lean.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the LeanAmountMax setting for this . maximum amount of lean.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

Sets the ChangeTimeMin setting for this . min time until changing direction.

Default value = 2.0f. Min value = 0.0f. Max value = 20.0f.

Sets the ChangeTimeMax setting for this . maximum time until changing direction.

Default value = 4.0f. Min value = 0.0f. Max value = 20.0f.

Creates a new Instance of the HipsLeanToPositionHelper for sending a HipsLeanToPosition to a given .

The to send the HipsLeanToPosition to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

Sets the Pos setting for this . position to head towards.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Creates a new Instance of the HipsLeanTowardsObjectHelper for sending a HipsLeanTowardsObject to a given .

The to send the HipsLeanTowardsObject to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

Sets the Offset setting for this . offset from instance position added when calculating position to lean to.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -100.0f. Max value = 100.0f.

Sets the InstanceIndex setting for this . levelIndex of object to lean hips towards.

Default value = -1. Min value = -1.

Sets the BoundIndex setting for this . boundIndex of object to lean hips towards (0 = just use instance coordinates).

Default value = 0. Min value = 0.

Creates a new Instance of the ForceLeanInDirectionHelper for sending a ForceLeanInDirection to a given .

The to send the ForceLeanInDirection to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the Dir setting for this . direction to lean in.

Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 0.0f.

Sets the BodyPart setting for this . body part that the force is applied to.

Default value = 0. Min value = 0. Max value = 21.

Creates a new Instance of the ForceLeanRandomHelper for sending a ForceLeanRandom to a given .

The to send the ForceLeanRandom to.

Sets the LeanAmountMin setting for this . minimum amount of lean.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the LeanAmountMax setting for this . maximum amount of lean.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

Sets the ChangeTimeMin setting for this . min time until changing direction.

Default value = 2.0f. Min value = 0.0f. Max value = 20.0f.

Sets the ChangeTimeMax setting for this . maximum time until changing direction.

Default value = 4.0f. Min value = 0.0f. Max value = 20.0f.

Sets the BodyPart setting for this . body part that the force is applied to.

Default value = 0. Min value = 0. Max value = 21.

Creates a new Instance of the ForceLeanToPositionHelper for sending a ForceLeanToPosition to a given .

The to send the ForceLeanToPosition to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

Sets the Pos setting for this . position to head towards.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the BodyPart setting for this . body part that the force is applied to.

Default value = 0. Min value = 0. Max value = 21.

Creates a new Instance of the ForceLeanTowardsObjectHelper for sending a ForceLeanTowardsObject to a given .

The to send the ForceLeanTowardsObject to.

Sets the LeanAmount setting for this . amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

Sets the Offset setting for this . offset from instance position added when calculating position to lean to.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -100.0f. Max value = 100.0f.

Sets the InstanceIndex setting for this . levelIndex of object to move towards.

Default value = -1. Min value = -1.

Sets the BoundIndex setting for this . boundIndex of object to move towards (0 = just use instance coordinates).

Default value = 0. Min value = 0.

Sets the BodyPart setting for this . body part that the force is applied to.

Default value = 0. Min value = 0. Max value = 21.

Use this message to manually set the body stiffness values -before using Active Pose to drive to an animated pose, for example.

Creates a new Instance of the SetStiffnessHelper for sending a SetStiffness to a given .

The to send the SetStiffness to. Use this message to manually set the body stiffness values -before using Active Pose to drive to an animated pose, for example.

Sets the BodyStiffness setting for this . stiffness of whole character.

Default value = 12.0f. Min value = 2.0f. Max value = 20.0f.

Sets the Damping setting for this . damping amount, less is underdamped.

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Use this message to manually set the muscle stiffness values -before using Active Pose to drive to an animated pose, for example.

Creates a new Instance of the SetMuscleStiffnessHelper for sending a SetMuscleStiffness to a given .

The to send the SetMuscleStiffness to. Use this message to manually set the muscle stiffness values -before using Active Pose to drive to an animated pose, for example.

Sets the MuscleStiffness setting for this . muscle stiffness of joint/s.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Use this message to set the character's weapon mode. This is an alternativeto the setWeaponMode public function.

Creates a new Instance of the SetWeaponModeHelper for sending a SetWeaponMode to a given .

The to send the SetWeaponMode to. Use this message to set the character's weapon mode. This is an alternativeto the setWeaponMode public function.

Sets the WeaponMode setting for this .

Default value = . .

Use this message to register weapon. This is an alternativeto the registerWeapon public function.

Creates a new Instance of the RegisterWeaponHelper for sending a RegisterWeapon to a given .

The to send the RegisterWeapon to. Use this message to register weapon. This is an alternativeto the registerWeapon public function.

Sets the Hand setting for this .

Default value = .

Sets the LevelIndex setting for this . Level index of the weapon.

Default value = -1. Min value = -1.

Sets the ConstraintHandle setting for this . pointer to the hand-gun constraint handle.

Default value = -1. Min value = -1.

Sets the GunToHandA setting for this . A vector of the gunToHand matrix. The gunToHandMatrix is the desired gunToHandMatrix in the aimingPose. (The gunToHandMatrix when pointGun starts can be different so will be blended to this desired one).

Default value = Vector3(1.0f, 0.0f, 0.0f). Min value = 0.0f.

Sets the GunToHandB setting for this . B vector of the gunToHand matrix.

Default value = Vector3(0.0f, 1.0f, 0.0f). Min value = 0.0f.

Sets the GunToHandC setting for this . C vector of the gunToHand matrix.

Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 0.0f.

Sets the GunToHandD setting for this . D vector of the gunToHand matrix.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = 0.0f.

Sets the GunToMuzzleInGun setting for this . Gun centre to muzzle expressed in gun co-ordinates. To get the line of sight/barrel of the gun. Assumption: the muzzle direction is always along the same primary axis of the gun.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the GunToButtInGun setting for this . Gun centre to butt expressed in gun co-ordinates. The gun pivots around this point when aiming.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Creates a new Instance of the ShotRelaxHelper for sending a ShotRelax to a given .

The to send the ShotRelax to.

Sets the RelaxPeriodUpper setting for this . time over which to relax to full relaxation for upper body.

Default value = 2.0f. Min value = 0.0f. Max value = 40.0f.

Sets the RelaxPeriodLower setting for this . time over which to relax to full relaxation for lower body.

Default value = 0.4f. Min value = 0.0f. Max value = 40.0f.

One shot message apply a force to the hand as we fire the gun that should be in this hand.

Creates a new Instance of the FireWeaponHelper for sending a FireWeapon to a given .

The to send the FireWeapon to. One shot message apply a force to the hand as we fire the gun that should be in this hand.

Sets the FiredWeaponStrength setting for this . The force of the gun.

Default value = 1000.0f. Min value = 0.0f. Max value = 10000.0f.

Sets the GunHandEnum setting for this . Which hand is the gun in.

Default value = .

Sets the ApplyFireGunForceAtClavicle setting for this . Should we apply some of the force at the shoulder. Force double handed weapons (Ak47 etc).

Default value = False.

Sets the InhibitTime setting for this . Minimum time before next fire impulse.

Default value = 0.4f. Min value = 0.0f. Max value = 10.0f.

Sets the Direction setting for this . direction of impulse in gun frame.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the Split setting for this . Split force between hand and clavicle when applyFireGunForceAtClavicle is true. 1 = all hand, 0 = all clavicle.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

One shot to give state of constraints on character and response to constraints.

Creates a new Instance of the ConfigureConstraintsHelper for sending a ConfigureConstraints to a given .

The to send the ConfigureConstraints to. One shot to give state of constraints on character and response to constraints.

Sets the HandCuffs setting for this .

Default value = False.

Sets the HandCuffsBehindBack setting for this . not implemented.

Default value = False.

Sets the LegCuffs setting for this . not implemented.

Default value = False.

Sets the RightDominant setting for this .

Default value = False.

Sets the PassiveMode setting for this . 0 setCurrent, 1= IK to dominant, (2=pointGunLikeIK //not implemented).

Default value = 0. Min value = 0. Max value = 5.

Sets the BespokeBehaviour setting for this . not implemented.

Default value = False.

Sets the Blend2ZeroPose setting for this . Blend Arms to zero pose.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Creates a new Instance of the StayUprightHelper for sending a StayUpright to a given .

The to send the StayUpright to.

Sets the UseForces setting for this . enable force based constraint.

Default value = False.

Sets the UseTorques setting for this . enable torque based constraint.

Default value = False.

Sets the LastStandMode setting for this . Uses position/orientation control on the spine and drifts in the direction of bullets. This ignores all other stayUpright settings.

Default value = False.

Sets the LastStandSinkRate setting for this . The sink rate (higher for a faster drop).

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the LastStandHorizDamping setting for this . Higher values for more damping.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

Sets the LastStandMaxTime setting for this . Max time allowed in last stand mode.

Default value = 0.4f. Min value = 0.0f. Max value = 5.0f.

Sets the TurnTowardsBullets setting for this . Use cheat torques to face the direction of bullets if not facing too far away.

Default value = False.

Sets the VelocityBased setting for this . make strength of constraint function of COM velocity. Uses -1 for forceDamping if the damping is positive.

Default value = False.

Sets the TorqueOnlyInAir setting for this . only apply torque based constraint when airBorne.

Default value = False.

Sets the ForceStrength setting for this . strength of constraint.

Default value = 3.0f. Min value = 0.0f. Max value = 16.0f.

Sets the ForceDamping setting for this . damping in constraint: -1 makes it scale automagically with forceStrength. Other negative values will scale this automagic damping.

Default value = -1.0f. Min value = -1.0f. Max value = 50.0f.

Sets the ForceFeetMult setting for this . multiplier to the force applied to the feet.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ForceSpine3Share setting for this . share of pelvis force applied to spine3.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the ForceLeanReduction setting for this . how much the character lean is taken into account when reducing the force.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ForceInAirShare setting for this . share of the feet force to the airborne foot.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the ForceMin setting for this . when min and max are greater than 0 the constraint strength is determined from character strength, scaled into the range given by min and max.

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

Sets the ForceMax setting for this . see above.

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

Sets the ForceSaturationVel setting for this . when in velocityBased mode, the COM velocity at which constraint reaches maximum strength (forceStrength).

Default value = 4.0f. Min value = 0.1f. Max value = 10.0f.

Sets the ForceThresholdVel setting for this . when in velocityBased mode, the COM velocity above which constraint starts applying forces.

Default value = 0.5f. Min value = 0.0f. Max value = 5.0f.

Sets the TorqueStrength setting for this . strength of torque based constraint.

Default value = 0.0f. Min value = 0.0f. Max value = 16.0f.

Sets the TorqueDamping setting for this . damping of torque based constraint.

Default value = 0.5f. Min value = 0.0f. Max value = 16.0f.

Sets the TorqueSaturationVel setting for this . when in velocityBased mode, the COM velocity at which constraint reaches maximum strength (torqueStrength).

Default value = 4.0f. Min value = 0.1f. Max value = 10.0f.

Sets the TorqueThresholdVel setting for this . when in velocityBased mode, the COM velocity above which constraint starts applying torques.

Default value = 2.5f. Min value = 0.0f. Max value = 5.0f.

Sets the SupportPosition setting for this . distance the foot is behind Com projection that is still considered able to generate the support for the upright constraint.

Default value = 2.0f. Min value = -2.0f. Max value = 2.0f.

Sets the NoSupportForceMult setting for this . still apply this fraction of the upright constaint force if the foot is not in a position (defined by supportPosition) to generate the support for the upright constraint.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the StepUpHelp setting for this . strength of cheat force applied upwards to spine3 to help the character up steps/slopes.

Default value = 0.0f. Min value = 0.0f. Max value = 16.0f.

Sets the StayUpAcc setting for this . How much the cheat force takes into account the acceleration of moving platforms.

Default value = 0.7f. Min value = 0.0f. Max value = 2.0f.

Sets the StayUpAccMax setting for this . The maximum floorAcceleration (of a moving platform) that the cheat force takes into account.

Default value = 5.0f. Min value = 0.0f. Max value = 15.0f.

Send this message to immediately stop all behaviours from executing.

Creates a new Instance of the StopAllBehavioursHelper for sending a StopAllBehaviours to a given .

The to send the StopAllBehaviours to. Send this message to immediately stop all behaviours from executing.

Sets character's strength on the dead-granny-to-healthy-terminator scale: [0..1].

Creates a new Instance of the SetCharacterStrengthHelper for sending a SetCharacterStrength to a given .

The to send the SetCharacterStrength to. Sets character's strength on the dead-granny-to-healthy-terminator scale: [0..1].

Sets the CharacterStrength setting for this . strength of character.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets character's health on the dead-to-alive scale: [0..1].

Creates a new Instance of the SetCharacterHealthHelper for sending a SetCharacterHealth to a given .

The to send the SetCharacterHealth to. Sets character's health on the dead-to-alive scale: [0..1].

Sets the CharacterHealth setting for this . health of character.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the type of reaction if catchFall is called.

Creates a new Instance of the SetFallingReactionHelper for sending a SetFallingReaction to a given .

The to send the SetFallingReaction to. Sets the type of reaction if catchFall is called.

Sets the HandsAndKnees setting for this . set to true to get handsAndKnees catchFall if catchFall called. If true allows the dynBalancer to stay on during the catchfall and modifies the catch fall to give a more alive looking performance (hands and knees for front landing or sitting up for back landing).

Default value = False.

Sets the CallRDS setting for this . If true catchFall will call rollDownstairs if comVel GT comVelRDSThresh - prevents excessive sliding in catchFall. Was previously only true for handsAndKnees.

Default value = False.

Sets the ComVelRDSThresh setting for this . comVel above which rollDownstairs will start - prevents excessive sliding in catchFall.

Default value = 2.0f. Min value = 0.0f. Max value = 20.0f.

Sets the ResistRolling setting for this . For rds catchFall only: True to resist rolling motion (rolling motion is set off by ub contact and a sliding velocity), false to allow more of a continuous rolling (rolling motion is set off at a sliding velocity).

Default value = False.

Sets the ArmReduceSpeed setting for this . Strength is reduced in the catchFall when the arms contact the ground. 0.2 is good for handsAndKnees. 2.5 is good for normal catchFall, anything lower than 1.0 for normal catchFall may lead to bad catchFall poses.

Default value = 2.5f. Min value = 0.0f. Max value = 10.0f.

Sets the ReachLengthMultiplier setting for this . Reach length multiplier that scales characters arm topological length, value in range from (0, 1 GT where 1.0 means reach length is maximum.

Default value = 1.0f. Min value = 0.3f. Max value = 1.0f.

Sets the InhibitRollingTime setting for this . Time after hitting ground that the catchFall can call rds.

Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.

Sets the ChangeFrictionTime setting for this . Time after hitting ground that the catchFall can change the friction of parts to inhibit sliding.

Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.

Sets the GroundFriction setting for this . 8.0 was used on yanked) Friction multiplier on bodyParts when on ground. Character can look too slidy with groundFriction = 1. Higher values give a more jerky reation but this seems timestep dependent especially for dragged by the feet.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the FrictionMin setting for this . Min Friction of an impact with a body part (not head, hands or feet) - to increase friction of slippy environment to get character to roll better. Applied in catchFall and rollUp(rollDownStairs).

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the FrictionMax setting for this . Max Friction of an impact with a body part (not head, hands or feet) - to increase friction of slippy environment to get character to roll better. Applied in catchFall and rollUp(rollDownStairs).

Default value = 9999.0f. Min value = 0.0f.

Sets the StopOnSlopes setting for this . Apply tactics to help stop on slopes.

Default value = False.

Sets the StopManual setting for this . Override slope value to manually force stopping on flat ground. Encourages character to come to rest face down or face up.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the StoppedStrengthDecay setting for this . Speed at which strength reduces when stopped.

Default value = 5.0f. Min value = 0.0f. Max value = 20.0f.

Sets the SpineLean1Offset setting for this . Bias spine post towards hunched (away from arched).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RiflePose setting for this . Hold rifle in a safe position to reduce complications with collision. Only applied if holding a rifle.

Default value = False.

Sets the HkHeadAvoid setting for this . Enable head ground avoidance when handsAndKnees is true.

Default value = True.

Sets the AntiPropClav setting for this . Discourage the character getting stuck propped up by elbows when falling backwards - by inhibiting backwards moving clavicles (keeps the arms slightly wider).

Default value = False.

Sets the AntiPropWeak setting for this . Discourage the character getting stuck propped up by elbows when falling backwards - by weakening the arms as soon they hit the floor. (Also stops the hands lifting up when flat on back).

Default value = False.

Sets the HeadAsWeakAsArms setting for this . Head weakens as arms weaken. If false and antiPropWeak when falls onto back doesn't loosen neck so early (matches bodyStrength instead).

Default value = True.

Sets the SuccessStrength setting for this . When bodyStrength is less than successStrength send a success feedback - DO NOT GO OUTSIDE MIN/MAX PARAMETER VALUES OTHERWISE NO SUCCESS FEEDBACK WILL BE SENT.

Default value = 1.0f. Min value = 0.3f. Max value = 1.0f.

Sets viscosity applied to damping limbs.

Creates a new Instance of the SetCharacterUnderwaterHelper for sending a SetCharacterUnderwater to a given .

The to send the SetCharacterUnderwater to. Sets viscosity applied to damping limbs.

Sets the Underwater setting for this . is character underwater?.

Default value = False.

Sets the Viscosity setting for this . viscosity applied to character's parts.

Default value = -1.0f. Min value = -1.0f. Max value = 100.0f.

Sets the GravityFactor setting for this . gravity factor applied to character.

Default value = 1.0f. Min value = -10.0f. Max value = 10.0f.

Sets the Stroke setting for this . swimming force applied to character as a function of handVelocity and footVelocity.

Default value = 0.0f. Min value = -1000.0f. Max value = 1000.0f.

Sets the LinearStroke setting for this . swimming force (linearStroke=true,False) = (f(v),f(v*v)).

Default value = False.

setCharacterCollisions:.

Creates a new Instance of the SetCharacterCollisionsHelper for sending a SetCharacterCollisions to a given .

The to send the SetCharacterCollisions to. setCharacterCollisions:.

Sets the Spin setting for this . sliding friction turned into spin 80.0 (used in demo videos) good for rest of default params below. If 0.0 then no collision enhancement.

Default value = 0.0f. Min value = 0.0f. Max value = 100.0f.

Sets the MaxVelocity setting for this . torque = spin*(relative velocity) up to this maximum for relative velocity.

Default value = 8.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ApplyToAll setting for this .

Default value = False.

Sets the ApplyToSpine setting for this .

Default value = True.

Sets the ApplyToThighs setting for this .

Default value = True.

Sets the ApplyToClavicles setting for this .

Default value = True.

Sets the ApplyToUpperArms setting for this .

Default value = True.

Sets the FootSlip setting for this . allow foot slipping if collided.

Default value = True.

Sets the VehicleClass setting for this . ClassType of the object against which to enhance the collision. All character vehicle interaction (e.g. braceForImpact glancing spins) relies on this value so EDIT WISELY. If it is used for things other than vehicles then NM should be informed.

Default value = 15. Min value = 0. Max value = 100.

Damp out cartwheeling and somersaulting above a certain threshold.

Creates a new Instance of the SetCharacterDampingHelper for sending a SetCharacterDamping to a given .

The to send the SetCharacterDamping to. Damp out cartwheeling and somersaulting above a certain threshold.

Sets the SomersaultThresh setting for this . Somersault AngularMomentum measure above which we start damping - try 34.0. Falling over straight backwards gives 54 on hitting ground.

Default value = 34.0f. Min value = 0.0f. Max value = 200.0f.

Sets the SomersaultDamp setting for this . Amount to damp somersaulting by (spinning around left/right axis) - try 0.45.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the CartwheelThresh setting for this . Cartwheel AngularMomentum measure above which we start damping - try 27.0.

Default value = 27.0f. Min value = 0.0f. Max value = 200.0f.

Sets the CartwheelDamp setting for this . Amount to damp somersaulting by (spinning around front/back axis) - try 0.8.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the VehicleCollisionTime setting for this . Time after impact with a vehicle to apply characterDamping. -ve values mean always apply whether collided with vehicle or not. =0.0 never apply. =timestep apply for only that frame. A typical roll from being hit by a car lasts about 4secs.

Default value = 0.0f. Min value = -1.0f. Max value = 1000.0f.

Sets the V2 setting for this . If true damping is proportional to Angular momentum squared. If false proportional to Angular momentum.

Default value = False.

setFrictionScale:.

Creates a new Instance of the SetFrictionScaleHelper for sending a SetFrictionScale to a given .

The to send the SetFrictionScale to. setFrictionScale:.

Sets the Scale setting for this . Friction scale to be applied to parts in mask.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the GlobalMin setting for this . Character-wide minimum impact friction. Affects all parts (not just those in mask).

Default value = 0.0f. Min value = 0.0f. Max value = 1000000.0f.

Sets the GlobalMax setting for this . Character-wide maximum impact friction. Affects all parts (not just those in mask).

Default value = 999999.0f. Min value = 0.0f. Max value = 1000000.0f.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Creates a new Instance of the AnimPoseHelper for sending a AnimPose to a given .

The to send the AnimPose to.

Sets the MuscleStiffness setting for this . muscleStiffness of masked joints. -values mean don't apply (just use defaults or ones applied by behaviours - safer if you are going to return to a behaviour).

Default value = -1.0f. Min value = -1.1f. Max value = 10.0f.

Sets the Stiffness setting for this . stiffness of masked joints. -ve values mean don't apply stiffness or damping (just use defaults or ones applied by behaviours). If you are using animpose fullbody on its own then this gives the opprtunity to use setStffness and setMuscleStiffness messages to set up the character's muscles. mmmmtodo get rid of this -ve.

Default value = -1.0f. Min value = -1.1f. Max value = 16.0f.

Sets the Damping setting for this . damping of masked joints.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the EffectorMask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see notes for explanation).

Default value = ub.

Sets the OverideHeadlook setting for this . overide Headlook behaviour (if animPose includes the head).

Default value = False.

Sets the OveridePointArm setting for this . overide PointArm behaviour (if animPose includes the arm/arms).

Default value = False.

Sets the OveridePointGun setting for this . overide PointGun behaviour (if animPose includes the arm/arms)//mmmmtodo not used at moment.

Default value = False.

Sets the UseZMPGravityCompensation setting for this . If true then modify gravity compensation based on stance (can reduce gravity compensation to zero if cofm is outside of balance area).

Default value = True.

Sets the GravityCompensation setting for this . gravity compensation applied to joints in the effectorMask. If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

Sets the MuscleStiffnessLeftArm setting for this . muscle stiffness applied to left arm (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Sets the MuscleStiffnessRightArm setting for this . muscle stiffness applied to right arm (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Sets the MuscleStiffnessSpine setting for this . muscle stiffness applied to spine (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Sets the MuscleStiffnessLeftLeg setting for this . muscle stiffness applied to left leg (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Sets the MuscleStiffnessRightLeg setting for this . muscle stiffness applied to right leg (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Sets the StiffnessLeftArm setting for this . stiffness applied to left arm (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

Sets the StiffnessRightArm setting for this . stiffness applied to right arm (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

Sets the StiffnessSpine setting for this . stiffness applied to spine (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

Sets the StiffnessLeftLeg setting for this . stiffness applied to left leg (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

Sets the StiffnessRightLeg setting for this . stiffness applied to right leg (applied after stiffness). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

Sets the DampingLeftArm setting for this . damping applied to left arm (applied after stiffness). If stiffness -ve then not applied (use current setting).

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the DampingRightArm setting for this . damping applied to right arm (applied after stiffness). If stiffness -ve then not applied (use current setting).

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the DampingSpine setting for this . damping applied to spine (applied after stiffness). If stiffness-ve then not applied (use current setting).

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the DampingLeftLeg setting for this . damping applied to left leg (applied after stiffness). If stiffness-ve then not applied (use current setting).

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the DampingRightLeg setting for this . damping applied to right leg (applied after stiffness). If stiffness -ve then not applied (use current setting).

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the GravCompLeftArm setting for this . gravity compensation applied to left arm (applied after gravityCompensation). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

Sets the GravCompRightArm setting for this . gravity compensation applied to right arm (applied after gravityCompensation). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

Sets the GravCompSpine setting for this . gravity compensation applied to spine (applied after gravityCompensation). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

Sets the GravCompLeftLeg setting for this . gravity compensation applied to left leg (applied after gravityCompensation). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

Sets the GravCompRightLeg setting for this . gravity compensation applied to right leg (applied after gravityCompensation). If -ve then not applied (use current setting).

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

Sets the ConnectedLeftHand setting for this . Is the left hand constrained to the world/ an object: -1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Default value = 0. Min value = -1. Max value = 2.

Sets the ConnectedRightHand setting for this . Is the right hand constrained to the world/ an object: -1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Default value = 0. Min value = -1. Max value = 2.

Sets the ConnectedLeftFoot setting for this . Is the left foot constrained to the world/ an object: -2=do not set in animpose (e.g. let the balancer decide), -1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Default value = -2. Min value = -2. Max value = 2.

Sets the ConnectedRightFoot setting for this . Is the right foot constrained to the world/ an object: -2=do not set in animpose (e.g. let the balancer decide),-1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Default value = -2. Min value = -2. Max value = 2.

Sets the AnimSource setting for this .

Sets the DampenSideMotionInstanceIndex setting for this . LevelIndex of object to dampen side motion relative to. -1 means not used.

Default value = -1. Min value = -1.

Creates a new Instance of the ArmsWindmillHelper for sending a ArmsWindmill to a given .

The to send the ArmsWindmill to.

Sets the LeftPartID setting for this . ID of part that the circle uses as local space for positioning.

Default value = 10. Min value = 0. Max value = 21.

Sets the LeftRadius1 setting for this . radius for first axis of ellipse.

Default value = 0.8f. Min value = 0.0f. Max value = 1.0f.

Sets the LeftRadius2 setting for this . radius for second axis of ellipse.

Default value = 0.8f. Min value = 0.0f. Max value = 1.0f.

Sets the LeftSpeed setting for this . speed of target around the circle.

Default value = 1.0f. Min value = -2.0f. Max value = 2.0f.

Sets the LeftNormal setting for this . Euler Angles orientation of circle in space of part with part ID.

Default value = Vector3(0.0f, 0.2f, 0.2f).

Sets the LeftCentre setting for this . centre of circle in the space of partID.

Default value = Vector3(0.0f, 0.5f, -0.1f).

Sets the RightPartID setting for this . ID of part that the circle uses as local space for positioning.

Default value = 10. Min value = 0. Max value = 21.

Sets the RightRadius1 setting for this . radius for first axis of ellipse.

Default value = 0.8f. Min value = 0.0f. Max value = 1.0f.

Sets the RightRadius2 setting for this . radius for second axis of ellipse.

Default value = 0.8f. Min value = 0.0f. Max value = 1.0f.

Sets the RightSpeed setting for this . speed of target around the circle.

Default value = 1.0f. Min value = -2.0f. Max value = 2.0f.

Sets the RightNormal setting for this . Euler Angles orientation of circle in space of part with part ID.

Default value = Vector3(0.0f, -0.2f, -0.2f).

Sets the RightCentre setting for this . centre of circle in the space of partID.

Default value = Vector3(0.0f, -0.5f, -0.1f).

Sets the ShoulderStiffness setting for this . Stiffness applied to the shoulders.

Default value = 12.0f. Min value = 1.0f. Max value = 16.0f.

Sets the ShoulderDamping setting for this . Damping applied to the shoulders.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the ElbowStiffness setting for this . Stiffness applied to the elbows.

Default value = 12.0f. Min value = 1.0f. Max value = 16.0f.

Sets the ElbowDamping setting for this . Damping applied to the elbows.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the LeftElbowMin setting for this . Minimum left elbow bend.

Default value = 0.5f. Min value = 0.0f. Max value = 1.7f.

Sets the RightElbowMin setting for this . Minimum right elbow bend.

Default value = 0.5f. Min value = 0.0f. Max value = 1.7f.

Sets the PhaseOffset setting for this . phase offset(degrees) when phase synchronization is turned on.

Default value = 0.0f. Min value = -360.0f. Max value = 360.0f.

Sets the DragReduction setting for this . how much to compensate for movement of character/target.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the IKtwist setting for this . angle of elbow around twist axis ?.

Default value = 0.0f. Min value = -3.1f. Max value = 3.1f.

Sets the AngVelThreshold setting for this . value of character angular speed above which adaptive arm motion starts.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the AngVelGain setting for this . multiplies angular speed of character to get speed of arms.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the MirrorMode setting for this .

Default value = . If leftArm parameters are used.

Sets the AdaptiveMode setting for this .

Default value = .

Sets the ForceSync setting for this . toggles phase synchronization.

Default value = True.

Sets the UseLeft setting for this . Use the left arm.

Default value = True.

Sets the UseRight setting for this . Use the right arm.

Default value = True.

Sets the DisableOnImpact setting for this . If true, each arm will stop windmilling if it hits the ground.

Default value = True.

Creates a new Instance of the ArmsWindmillAdaptiveHelper for sending a ArmsWindmillAdaptive to a given .

The to send the ArmsWindmillAdaptive to.

Sets the AngSpeed setting for this . Controls the speed of the windmilling.

Default value = 6.3f. Min value = 0.1f. Max value = 10.0f.

Sets the BodyStiffness setting for this . Controls how stiff the rest of the body is.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Amplitude setting for this . Controls how large the motion is, higher values means the character waves his arms in a massive arc.

Default value = 0.6f. Min value = 0.0f. Max value = 2.0f.

Sets the Phase setting for this . Set to a non-zero value to desynchronise the left and right arms motion.

Default value = 0.0f. Min value = -4.0f. Max value = 8.0f.

Sets the ArmStiffness setting for this . How stiff the arms are controls how pronounced the windmilling motion appears.

Default value = 14.1f. Min value = 6.0f. Max value = 16.0f.

Sets the LeftElbowAngle setting for this . If not negative then left arm will blend to this angle.

Default value = -1.0f. Min value = -1.0f. Max value = 6.0f.

Sets the RightElbowAngle setting for this . If not negative then right arm will blend to this angle.

Default value = -1.0f. Min value = -1.0f. Max value = 6.0f.

Sets the Lean1mult setting for this . 0 arms go up and down at the side. 1 circles. 0..1 elipse.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the Lean1offset setting for this . 0.f centre of circle at side.

Default value = 0.0f. Min value = -6.0f. Max value = 6.0f.

Sets the ElbowRate setting for this . rate at which elbow tries to match *ElbowAngle.

Default value = 1.0f. Min value = 0.0f. Max value = 6.0f.

Sets the ArmDirection setting for this .

Default value = .

Sets the DisableOnImpact setting for this . If true, each arm will stop windmilling if it hits the ground.

Default value = True.

Sets the SetBackAngles setting for this . If true, back angles will be set to compliment arms windmill.

Default value = True.

Sets the UseAngMom setting for this . If true, use angular momentum about com to choose arm circling direction. Otherwise use com angular velocity.

Default value = False.

Sets the BendLeftElbow setting for this . If true, bend the left elbow to give a stuntman type scramble look.

Default value = False.

Sets the BendRightElbow setting for this . If true, bend the right elbow to give a stuntman type scramble look.

Default value = False.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = ub.

Creates a new Instance of the BalancerCollisionsReactionHelper for sending a BalancerCollisionsReaction to a given .

The to send the BalancerCollisionsReaction to.

Sets the NumStepsTillSlump setting for this . Begin slump and stop stepping after this many steps.

Default value = 4. Min value = 0.

Sets the Stable2SlumpTime setting for this . Time after becoming stable leaning against a wall that slump starts.

Default value = 0.0f. Min value = 0.0f.

Sets the ExclusionZone setting for this . Steps are ihibited to not go closer to the wall than this (after impact).

Default value = 0.2f. Min value = 0.0f.

Sets the FootFrictionMultStart setting for this . Friction multiplier applied to feet when slump starts.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the FootFrictionMultRate setting for this . Friction multiplier reduced by this amount every second after slump starts (only if character is not slumping).

Default value = 2.0f. Min value = 0.0f. Max value = 50.0f.

Sets the BackFrictionMultStart setting for this . Friction multiplier applied to back when slump starts.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the BackFrictionMultRate setting for this . Friction multiplier reduced by this amount every second after slump starts (only if character is not slumping).

Default value = 2.0f. Min value = 0.0f. Max value = 50.0f.

Sets the ImpactLegStiffReduction setting for this . Reduce the stiffness of the legs by this much as soon as an impact is detected.

Default value = 3.0f. Min value = 0.0f. Max value = 16.0f.

Sets the SlumpLegStiffReduction setting for this . Reduce the stiffness of the legs by this much as soon as slump starts.

Default value = 1.0f. Min value = 0.0f. Max value = 16.0f.

Sets the SlumpLegStiffRate setting for this . Rate at which the stiffness of the legs is reduced during slump.

Default value = 8.0f. Min value = 0.0f. Max value = 50.0f.

Sets the ReactTime setting for this . Time that the character reacts to the impact with ub flinch and writhe.

Default value = 0.3f. Min value = 0.0f. Max value = 2.0f.

Sets the ImpactExagTime setting for this . Time that the character exaggerates impact with spine.

Default value = 0.3f. Min value = 0.0f. Max value = 2.0f.

Sets the GlanceSpinTime setting for this . Duration that the glance torque is applied for.

Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.

Sets the GlanceSpinMag setting for this . Magnitude of the glance torque.

Default value = 50.0f. Min value = 0.0f. Max value = 1000.0f.

Sets the GlanceSpinDecayMult setting for this . multiplier used when decaying torque spin over time.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the IgnoreColWithIndex setting for this . used so impact with the character that is pushing you over doesn't set off the behaviour.

Default value = -2. Min value = -2.

Sets the SlumpMode setting for this . 0=Normal slump(less movement then slump and movement LT small), 1=fast slump, 2=less movement then slump.

Default value = 1. Min value = 0. Max value = 2.

Sets the ReboundMode setting for this . 0=fall2knees/slump if shot not running, 1=stumble, 2=slump, 3=restart.

Default value = 0. Min value = 0. Max value = 3.

Sets the IgnoreColMassBelow setting for this . collisions with non-fixed objects with mass below this will not set this behaviour off (e.g. ignore guns).

Default value = 20.0f. Min value = -1.0f. Max value = 1000.0f.

Sets the ForwardMode setting for this . 0=slump, 1=fallToKnees if shot is running, otherwise slump.

Default value = 0. Min value = 0. Max value = 1.

Sets the TimeToForward setting for this . time after a forwards impact before forwardMode is called (leave sometime for a rebound or brace - the min of 0.1 is to ensure fallOverWall can start although it probably needs only 1or2 frames for the probes to return).

Default value = 0.5f. Min value = 0.1f. Max value = 2.0f.

Sets the ReboundForce setting for this . if forwards impact only: cheat force to try to get the character away from the wall. 3 is a good value.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the BraceWall setting for this . Brace against wall if forwards impact(at the moment only if bodyBalance is running/in charge of arms).

Default value = True.

Sets the IgnoreColVolumeBelow setting for this . collisions with non-fixed objects with volume below this will not set this behaviour off.

Default value = 0.1f. Min value = -1.0f. Max value = 1000.0f.

Sets the FallOverWallDrape setting for this . use fallOverWall as the main drape reaction.

Default value = True.

Sets the FallOverHighWalls setting for this . trigger fall over wall if hit up to spine2 else only if hit up to spine1.

Default value = False.

Sets the Snap setting for this . Add a Snap to when you hit a wall to emphasize the hit.

Default value = False.

Sets the SnapMag setting for this . The magnitude of the snap reaction.

Default value = -0.6f. Min value = -10.0f. Max value = 10.0f.

Sets the SnapDirectionRandomness setting for this . The character snaps in a prescribed way (decided by bullet direction) - Higher the value the more random this direction is.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the SnapLeftArm setting for this . snap the leftArm.

Default value = False.

Sets the SnapRightArm setting for this . snap the rightArm.

Default value = False.

Sets the SnapLeftLeg setting for this . snap the leftLeg.

Default value = False.

Sets the SnapRightLeg setting for this . snap the rightLeg.

Default value = False.

Sets the SnapSpine setting for this . snap the spine.

Default value = True.

Sets the SnapNeck setting for this . snap the neck.

Default value = True.

Sets the SnapPhasedLegs setting for this . Legs are either in phase with each other or not.

Default value = True.

Sets the SnapHipType setting for this . type of hip reaction 0=none, 1=side2side 2=steplike.

Default value = 0. Min value = 0. Max value = 2.

Sets the UnSnapInterval setting for this . Interval before applying reverse snap.

Default value = 0.0f. Min value = 0.0f. Max value = 100.0f.

Sets the UnSnapRatio setting for this . The magnitude of the reverse snap.

Default value = 0.7f. Min value = 0.0f. Max value = 100.0f.

Sets the SnapUseTorques setting for this . use torques to make the snap otherwise use a change in the parts angular velocity.

Default value = True.

Sets the ImpactWeaknessZeroDuration setting for this . duration for which the character's upper body stays at minimum stiffness (not quite zero).

Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.

Sets the ImpactWeaknessRampDuration setting for this . duration of the ramp to bring the character's upper body stiffness back to normal levels.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ImpactLoosenessAmount setting for this . how loose the character is on impact. between 0 and 1.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ObjectBehindVictim setting for this . detected an object behind a shot victim in the direction of a bullet?.

Default value = False.

Sets the ObjectBehindVictimPos setting for this . the intersection pos of a detected object behind a shot victim in the direction of a bullet.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the ObjectBehindVictimNormal setting for this . the normal of a detected object behind a shot victim in the direction of a bullet.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

Creates a new Instance of the BodyBalanceHelper for sending a BodyBalance to a given .

The to send the BodyBalance to.

Sets the ArmStiffness setting for this . NB. WAS m_bodyStiffness ClaviclesStiffness=9.0f.

Default value = 9.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Elbow setting for this . How much the elbow swings based on the leg movement.

Default value = 0.9f. Min value = 0.0f. Max value = 4.0f.

Sets the Shoulder setting for this . How much the shoulder(lean1) swings based on the leg movement.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the ArmDamping setting for this . NB. WAS m_damping NeckDamping=1 ClaviclesDamping=1.

Default value = 0.7f. Min value = 0.0f. Max value = 2.0f.

Sets the UseHeadLook setting for this . enable and provide a look-at target to make the character's head turn to face it while balancing.

Default value = False.

Sets the HeadLookPos setting for this . position of thing to look at.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the HeadLookInstanceIndex setting for this . level index of thing to look at.

Default value = -1. Min value = -1.

Sets the SpineStiffness setting for this .

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

Sets the SomersaultAngle setting for this . multiplier of the somersault 'angle' (lean forward/back) for arms out (lean2).

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the SomersaultAngleThreshold setting for this . Amount of somersault 'angle' before m_somersaultAngle is used for ArmsOut. Unless drunk - DO NOT EXCEED 0.8.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the SideSomersaultAngle setting for this . Amount of side somersault 'angle' before sideSomersault is used for ArmsOut. Unless drunk - DO NOT EXCEED 0.8.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SideSomersaultAngleThreshold setting for this .

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the BackwardsAutoTurn setting for this . Automatically turn around if moving backwards.

Default value = False.

Sets the TurnWithBumpRadius setting for this . 0.9 is a sensible value. If pusher within this distance then turn to get out of the way of the pusher.

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Sets the BackwardsArms setting for this . Bend elbows, relax shoulders and inhibit spine twist when moving backwards.

Default value = False.

Sets the BlendToZeroPose setting for this . Blend upper body to zero pose as the character comes to rest. If false blend to a stored pose.

Default value = False.

Sets the ArmsOutOnPush setting for this . Put arms out based on lean2 of legs, or angular velocity (lean or twist), or lean (front/back or side/side).

Default value = True.

Sets the ArmsOutOnPushMultiplier setting for this . Arms out based on lean2 of the legs to simulate being pushed.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the ArmsOutOnPushTimeout setting for this . number of seconds before turning off the armsOutOnPush response only for Arms out based on lean2 of the legs (NOT for the angle or angular velocity).

Default value = 1.1f. Min value = 0.0f. Max value = 2.0f.

Sets the ReturningToBalanceArmsOut setting for this . range 0:1 0 = don't raise arms if returning to upright position, 0.x = 0.x*raise arms based on angvel and 'angle' settings, 1 = raise arms based on angvel and 'angle' settings.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ArmsOutStraightenElbows setting for this . multiplier for straightening the elbows based on the amount of arms out(lean2) 0 = dont straighten elbows. Otherwise straighten elbows proportionately to armsOut.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ArmsOutMinLean2 setting for this . Minimum desiredLean2 applied to shoulder (to stop arms going above shoulder height or not).

Default value = -9.9f. Min value = -10.0f. Max value = 0.0f.

Sets the SpineDamping setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the UseBodyTurn setting for this .

Default value = True.

Sets the ElbowAngleOnContact setting for this . on contact with upperbody the desired elbow angle is set to at least this value.

Default value = 1.9f. Min value = 0.0f. Max value = 3.0f.

Sets the BendElbowsTime setting for this . Time after contact (with Upper body) that the min m_elbowAngleOnContact is applied.

Default value = 0.3f. Min value = 0.0f. Max value = 2.0f.

Sets the BendElbowsGait setting for this . Minimum desired angle of elbow during non contact arm swing.

Default value = 0.7f. Min value = -3.0f. Max value = 3.0f.

Sets the HipL2ArmL2 setting for this . mmmmdrunk = 0.2 multiplier of hip lean2 (star jump) to give shoulder lean2 (flapping).

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the ShoulderL2 setting for this . mmmmdrunk = 0.7 shoulder lean2 offset.

Default value = 0.5f. Min value = -3.0f. Max value = 3.0f.

Sets the ShoulderL1 setting for this . mmmmdrunk 1.1 shoulder lean1 offset (+ve frankenstein).

Default value = 0.0f. Min value = -1.0f. Max value = 2.0f.

Sets the ShoulderTwist setting for this . mmmmdrunk = 0.0 shoulder twist.

Default value = -0.4f. Min value = -3.0f. Max value = 3.0f.

Sets the HeadLookAtVelProb setting for this . Probability [0-1] that headLook will be looking in the direction of velocity when stepping.

Default value = -1.0f. Min value = -1.0f. Max value = 1.0f.

Sets the TurnOffProb setting for this . Weighted Probability that turn will be off. This is one of six turn type weights.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the Turn2VelProb setting for this . Weighted Probability of turning towards velocity. This is one of six turn type weights.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the TurnAwayProb setting for this . Weighted Probability of turning away from headLook target. This is one of six turn type weights.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the TurnLeftProb setting for this . Weighted Probability of turning left. This is one of six turn type weights.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the TurnRightProb setting for this . Weighted Probability of turning right. This is one of six turn type weights.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the Turn2TargetProb setting for this . Weighted Probability of turning towards headLook target. This is one of six turn type weights.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the AngVelMultiplier setting for this . somersault, twist, sideSomersault) multiplier of the angular velocity for arms out (lean2) (somersault, twist, sideSomersault).

Default value = Vector3(4.0f, 1.0f, 4.0f). Min value = 0.0f. Max value = 20.0f.

Sets the AngVelThreshold setting for this . somersault, twist, sideSomersault) threshold above which angVel is used for arms out (lean2) Unless drunk - DO NOT EXCEED 7.0 for each component.

Default value = Vector3(1.2f, 3.0f, 1.2f). Min value = 0.0f. Max value = 40.0f.

Sets the BraceDistance setting for this . if -ve then do not brace. distance from object at which to raise hands to brace 0.5 good if newBrace=true - otherwise 0.65.

Default value = -1.0f. Min value = -1.0f. Max value = 1.0f.

Sets the TargetPredictionTime setting for this . time expected to get arms up from idle.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the ReachAbsorbtionTime setting for this . larger values and he absorbs the impact more.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the BraceStiffness setting for this . stiffness of character. catch_fall stiffness scales with this too, with its defaults at this values default.

Default value = 12.0f. Min value = 6.0f. Max value = 16.0f.

Sets the MinBraceTime setting for this . minimum bracing time so the character doesn't look twitchy.

Default value = 0.3f. Min value = 0.0f. Max value = 3.0f.

Sets the TimeToBackwardsBrace setting for this . time before arm brace kicks in when hit from behind.

Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.

Sets the HandsDelayMin setting for this . If bracing with 2 hands delay one hand by at least this amount of time to introduce some asymmetry.

Default value = 0.3f. Min value = 0.0f. Max value = 3.0f.

Sets the HandsDelayMax setting for this . If bracing with 2 hands delay one hand by at most this amount of time to introduce some asymmetry.

Default value = 0.7f. Min value = 0.0f. Max value = 3.0f.

Sets the BraceOffset setting for this . braceTarget is global headLookPos plus braceOffset m in the up direction.

Default value = 0.0f. Min value = -2.0f. Max value = 2.0f.

Sets the MoveRadius setting for this . if -ve don't move away from pusher unless moveWhenBracing is true and braceDistance GT 0.0f. if the pusher is closer than moveRadius then move away from it.

Default value = -1.0f. Min value = -1.0f. Max value = 2.0f.

Sets the MoveAmount setting for this . amount of leanForce applied away from pusher.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the MoveWhenBracing setting for this . Only move away from pusher when bracing against pusher.

Default value = False.

Creates a new Instance of the BodyFoetalHelper for sending a BodyFoetal to a given .

The to send the BodyFoetal to.

Sets the Stiffness setting for this . The stiffness of the body determines how fast the character moves into the position, and how well that they hold it.

Default value = 9.0f. Min value = 6.0f. Max value = 16.0f.

Sets the DampingFactor setting for this . Sets damping value for the character joints.

Default value = 1.4f. Min value = 0.0f. Max value = 2.0f.

Sets the Asymmetry setting for this . A value between 0-1 that controls how asymmetric the results are by varying stiffness across the body.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RandomSeed setting for this . Random seed used to generate asymmetry values.

Default value = 100. Min value = 0.

Sets the BackTwist setting for this . Amount of random back twist to add.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Creates a new Instance of the BodyRollUpHelper for sending a BodyRollUp to a given .

The to send the BodyRollUp to.

Sets the Stiffness setting for this . stiffness of whole body.

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

Sets the UseArmToSlowDown setting for this . the degree to which the character will try to stop a barrel roll with his arms.

Default value = 1.3f. Min value = -2.0f. Max value = 3.0f.

Sets the ArmReachAmount setting for this . the likeliness of the character reaching for the ground with its arms.

Default value = 1.4f. Min value = 0.0f. Max value = 3.0f.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Sets the LegPush setting for this . used to keep rolling down slope, 1 is full (kicks legs out when pointing upwards).

Default value = 0.0f. Min value = -1.0f. Max value = 2.0f.

Sets the AsymmetricalLegs setting for this . 0 is no leg asymmetry in 'foetal' position. greater than 0 a asymmetricalLegs-rand(30%), added/minus each joint of the legs in radians. Random number changes about once every roll. 0.4 gives a lot of asymmetry.

Default value = 0.0f. Min value = -2.0f. Max value = 2.0f.

Sets the NoRollTimeBeforeSuccess setting for this . time that roll velocity has to be lower than rollVelForSuccess, before success message is sent.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the RollVelForSuccess setting for this . lower threshold for roll velocity at which success message can be sent.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the RollVelLinearContribution setting for this . contribution of linear COM velocity to roll Velocity (if 0, roll velocity equal to COM angular velocity).

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the VelocityScale setting for this . Scales perceived body velocity. The higher this value gets, the more quickly the velocity measure saturates, resulting in a tighter roll at slower speeds. (NB: Set to 1 to match earlier behaviour).

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the VelocityOffset setting for this . Offsets perceived body velocity. Increase to create larger "dead zone" around zero velocity where character will be less rolled. (NB: Reset to 0 to match earlier behaviour).

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ApplyMinMaxFriction setting for this . Controls whether or not behaviour enforces min/max friction.

Default value = True.

Creates a new Instance of the BodyWritheHelper for sending a BodyWrithe to a given .

The to send the BodyWrithe to.

Sets the ArmStiffness setting for this .

Default value = 13.0f. Min value = 6.0f. Max value = 16.0f.

Sets the BackStiffness setting for this .

Default value = 13.0f. Min value = 6.0f. Max value = 16.0f.

Sets the LegStiffness setting for this . The stiffness of the character will determine how 'determined' a writhe this is - high values will make him thrash about wildly.

Default value = 13.0f. Min value = 6.0f. Max value = 16.0f.

Sets the ArmDamping setting for this . damping amount, less is underdamped.

Default value = 0.5f. Min value = 0.0f. Max value = 3.0f.

Sets the BackDamping setting for this . damping amount, less is underdamped.

Default value = 0.5f. Min value = 0.0f. Max value = 3.0f.

Sets the LegDamping setting for this . damping amount, less is underdamped.

Default value = 0.5f. Min value = 0.0f. Max value = 3.0f.

Sets the ArmPeriod setting for this . Controls how fast the writhe is executed, smaller values make faster motions.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the BackPeriod setting for this . Controls how fast the writhe is executed, smaller values make faster motions.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the LegPeriod setting for this . Controls how fast the writhe is executed, smaller values make faster motions.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Sets the ArmAmplitude setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the BackAmplitude setting for this . scales the amount of writhe. 0 = no writhe.

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the LegAmplitude setting for this . scales the amount of writhe. 0 = no writhe.

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the ElbowAmplitude setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the KneeAmplitude setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the RollOverFlag setting for this . Flag to set trying to rollOver.

Default value = False.

Sets the BlendArms setting for this . Blend the writhe arms with the current desired arms (0=don't apply any writhe, 1=only writhe).

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the BlendBack setting for this . Blend the writhe spine and neck with the current desired (0=don't apply any writhe, 1=only writhe).

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the BlendLegs setting for this . Blend the writhe legs with the current desired legs (0=don't apply any writhe, 1=only writhe).

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ApplyStiffness setting for this . Use writhe stiffnesses if true. If false don't set any stiffnesses.

Default value = True.

Sets the OnFire setting for this . Extra shoulderBlend. Rolling:one way only, maxRollOverTime, rollOverRadius, doesn't reduce arm stiffness to help rolling. No shoulder twist.

Default value = False.

Sets the ShoulderLean1 setting for this . Blend writhe shoulder desired lean1 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect.

Default value = 0.7f. Min value = 0.0f. Max value = 6.3f.

Sets the ShoulderLean2 setting for this . Blend writhe shoulder desired lean2 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect.

Default value = 0.4f. Min value = 0.0f. Max value = 6.3f.

Sets the Lean1BlendFactor setting for this . Shoulder desired lean1 with shoulderLean1 angle blend factor. Set it to 0 to use original shoulder withe desired lean1 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Lean2BlendFactor setting for this . Shoulder desired lean2 with shoulderLean2 angle blend factor. Set it to 0 to use original shoulder withe desired lean2 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RollTorqueScale setting for this . Scale rolling torque that is applied to character spine.

Default value = 150.0f. Min value = 0.0f. Max value = 300.0f.

Sets the MaxRollOverTime setting for this . Rolling torque is ramped down over time. At this time in seconds torque value converges to zero. Use this parameter to restrict time the character is rolling. Note that onFire has to be set to true for this parameter to take any effect.

Default value = 8.0f. Min value = 0.0f. Max value = 60.0f.

Sets the RollOverRadius setting for this . Rolling torque is ramped down with distance measured from position where character hit the ground and started rolling. At this distance in meters torque value converges to zero. Use this parameter to restrict distance the character travels due to rolling. Note that onFire has to be set to true for this parameter to take any effect.

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Creates a new Instance of the BraceForImpactHelper for sending a BraceForImpact to a given .

The to send the BraceForImpact to.

Sets the BraceDistance setting for this . distance from object at which to raise hands to brace 0.5 good if newBrace=true - otherwise 0.65.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the TargetPredictionTime setting for this . time epected to get arms up from idle.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the ReachAbsorbtionTime setting for this . larger values and he absorbs the impact more.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the InstanceIndex setting for this . levelIndex of object to brace.

Default value = -1. Min value = -1.

Sets the BodyStiffness setting for this . stiffness of character. catch_fall stiffness scales with this too, with its defaults at this values default.

Default value = 12.0f. Min value = 6.0f. Max value = 16.0f.

Sets the GrabDontLetGo setting for this . Once a constraint is made, keep reaching with whatever hand is allowed.

Default value = False.

Sets the GrabStrength setting for this . strength in hands for grabbing (kg m/s), -1 to ignore/disable.

Default value = 40.0f. Min value = -1.0f. Max value = 1000.0f.

Sets the GrabDistance setting for this . Relative distance at which the grab starts.

Default value = 2.0f. Min value = 0.0f. Max value = 4.0f.

Sets the GrabReachAngle setting for this . Angle from front at which the grab activates. If the point is outside this angle from front will not try to grab.

Default value = 1.5f. Min value = 0.0f. Max value = 3.2f.

Sets the GrabHoldTimer setting for this . amount of time, in seconds, before grab automatically bails.

Default value = 2.5f. Min value = 0.0f. Max value = 10.0f.

Sets the MaxGrabCarVelocity setting for this . Don't try to grab a car moving above this speed mmmmtodo make this the relative velocity of car to character?.

Default value = 95.0f. Min value = 0.0f. Max value = 1000.0f.

Sets the LegStiffness setting for this . Balancer leg stiffness mmmmtodo remove this parameter and use configureBalance?.

Default value = 12.0f. Min value = 6.0f. Max value = 16.0f.

Sets the TimeToBackwardsBrace setting for this . time before arm brace kicks in when hit from behind.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the Look setting for this . position to look at, e.g. the driver.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the Pos setting for this . location of the front part of the object to brace against. This should be the centre of where his hands should meet the object.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the MinBraceTime setting for this . minimum bracing time so the character doesn't look twitchy.

Default value = 0.3f. Min value = 0.0f. Max value = 3.0f.

Sets the HandsDelayMin setting for this . If bracing with 2 hands delay one hand by at least this amount of time to introduce some asymmetry.

Default value = 0.1f. Min value = 0.0f. Max value = 3.0f.

Sets the HandsDelayMax setting for this . If bracing with 2 hands delay one hand by at most this amount of time to introduce some asymmetry.

Default value = 0.3f. Min value = 0.0f. Max value = 3.0f.

Sets the MoveAway setting for this . move away from the car (if in reaching zone).

Default value = False.

Sets the MoveAwayAmount setting for this . forceLean away amount (-ve is lean towards).

Default value = 0.1f. Min value = -1.0f. Max value = 1.0f.

Sets the MoveAwayLean setting for this . Lean away amount (-ve is lean towards).

Default value = 0.1f. Min value = -0.5f. Max value = 0.5f.

Sets the MoveSideways setting for this . Amount of sideways movement if at the front or back of the car to add to the move away from car.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the BbArms setting for this . Use bodyBalance arms for the default (non bracing) behaviour if bodyBalance is active.

Default value = False.

Sets the NewBrace setting for this . Use the new brace prediction code.

Default value = True.

Sets the BraceOnImpact setting for this . If true then if a shin or thigh is in contact with the car then brace. NB: newBrace must be true. For those situations where the car has pushed the ped backwards (at the same speed as the car) before the behaviour has been started and so doesn't predict an impact.

Default value = False.

Sets the Roll2Velocity setting for this . When rollDownStairs is running use roll2Velocity to control the helper torques (this only attempts to roll to the chaarcter's velocity not some default linear velocity mag.

Default value = False.

Sets the RollType setting for this . 0 = original/roll off/stay on car: Roll with character velocity, 1 = //Gentle: roll off/stay on car = use relative velocity of character to car to roll against, 2 = //roll over car: Roll against character velocity. i.e. roll against any velocity picked up by hitting car, 3 = //Gentle: roll over car: use relative velocity of character to car to roll with.

Default value = 3. Min value = 0. Max value = 3.

Sets the SnapImpacts setting for this . Exaggerate impacts using snap.

Default value = False.

Sets the SnapImpact setting for this . Exaggeration amount of the initial impact (legs). +ve fold with car impact (as if pushed at hips in the car velocity direction). -ve fold away from car impact.

Default value = 7.0f. Min value = -20.0f. Max value = 20.0f.

Sets the SnapBonnet setting for this . Exaggeration amount of the secondary (torso) impact with bonnet. +ve fold with car impact (as if pushed at hips by the impact normal). -ve fold away from car impact.

Default value = -7.0f. Min value = -20.0f. Max value = 20.0f.

Sets the SnapFloor setting for this . Exaggeration amount of the impact with the floor after falling off of car +ve fold with floor impact (as if pushed at hips in the impact normal direction). -ve fold away from car impact.

Default value = 7.0f. Min value = -20.0f. Max value = 20.0f.

Sets the DampVel setting for this . Damp out excessive spin and upward velocity when on car.

Default value = False.

Sets the DampSpin setting for this . Amount to damp spinning by (cartwheeling and somersaulting).

Default value = 0.0f. Min value = 0.0f. Max value = 40.0f.

Sets the DampUpVel setting for this . Amount to damp upward velocity by to limit the amount of air above the car the character can get.

Default value = 10.0f. Min value = 0.0f. Max value = 40.0f.

Sets the DampSpinThresh setting for this . Angular velocity above which we start damping.

Default value = 4.0f. Min value = 0.0f. Max value = 20.0f.

Sets the DampUpVelThresh setting for this . Upward velocity above which we start damping.

Default value = 2.0f. Min value = 0.0f. Max value = 20.0f.

Sets the GsHelp setting for this . Enhance a glancing spin with the side of the car by modulating body friction.

Default value = False.

Sets the GsEndMin setting for this . ID for glancing spin. min depth to be considered from either end (front/rear) of a car (-ve is inside the car area).

Default value = -0.1f. Min value = -10.0f. Max value = 1.0f.

Sets the GsSideMin setting for this . ID for glancing spin. min depth to be considered on the side of a car (-ve is inside the car area).

Default value = -0.2f. Min value = -10.0f. Max value = 1.0f.

Sets the GsSideMax setting for this . ID for glancing spin. max depth to be considered on the side of a car (+ve is outside the car area).

Default value = 0.5f. Min value = -10.0f. Max value = 1.0f.

Sets the GsUpness setting for this . ID for glancing spin. Character has to be more upright than this value for it to be considered on the side of a car. Fully upright = 1, upsideDown = -1. Max Angle from upright is acos(gsUpness).

Default value = 0.9f. Min value = 0.0f. Max value = 10.0f.

Sets the GsCarVelMin setting for this . ID for glancing spin. Minimum car velocity.

Default value = 3.0f. Min value = 0.0f. Max value = 10.0f.

Sets the GsScale1Foot setting for this . Apply gsFricScale1 to the foot if colliding with car. (Otherwise foot friction - with the ground - is determined by gsFricScale2 if it is in gsFricMask2).

Default value = True.

Sets the GsFricScale1 setting for this . Glancing spin help. Friction scale applied when to the side of the car. e.g. make the character spin more by upping the friction against the car.

Default value = 8.0f. Min value = 0.0f. Max value = 10.0f.

Sets the GsFricMask1 setting for this . Glancing spin help. Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see notes for explanation). Note gsFricMask1 and gsFricMask2 are made independent by the code so you can have fb for gsFricMask1 but gsFricScale1 will not be applied to any bodyParts in gsFricMask2.

Default value = fb.

Sets the GsFricScale2 setting for this . Glancing spin help. Friction scale applied when to the side of the car. e.g. make the character spin more by lowering the feet friction. You could also lower the wrist friction here to stop the car pulling along the hands i.e. gsFricMask2 = la|uw.

Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.

Sets the GsFricMask2 setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see notes for explanation). Note gsFricMask1 and gsFricMask2 are made independent by the code so you can have fb for gsFricMask1 but gsFricScale1 will not be applied to any bodyParts in gsFricMask2.

Default value = la.

Simple buoyancy model. No character movement just fluid forces/torques added to parts.

Creates a new Instance of the BuoyancyHelper for sending a Buoyancy to a given .

The to send the Buoyancy to. Simple buoyancy model. No character movement just fluid forces/torques added to parts.

Sets the SurfacePoint setting for this . Arbitrary point on surface of water.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the SurfaceNormal setting for this . Normal to surface of water.

Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 0.0f.

Sets the Buoyancy setting for this . Buoyancy multiplier.

Default value = 1.0f. Min value = 0.0f.

Sets the ChestBuoyancy setting for this . Buoyancy mulplier for spine2/3. Helps character float upright.

Default value = 8.0f. Min value = 0.0f.

Sets the Damping setting for this . Damping for submerged parts.

Default value = 40.0f. Min value = 0.0f.

Sets the Righting setting for this . Use righting torque to being character face-up in water?.

Default value = True.

Sets the RightingStrength setting for this . Strength of righting torque.

Default value = 25.0f. Min value = 0.0f.

Sets the RightingTime setting for this . How long to wait after chest hits water to begin righting torque.

Default value = 1.0f. Min value = 0.0f.

Creates a new Instance of the CatchFallHelper for sending a CatchFall to a given .

The to send the CatchFall to.

Sets the TorsoStiffness setting for this . stiffness of torso.

Default value = 9.0f. Min value = 6.0f. Max value = 16.0f.

Sets the LegsStiffness setting for this . stiffness of legs.

Default value = 6.0f. Min value = 4.0f. Max value = 16.0f.

Sets the ArmsStiffness setting for this . stiffness of arms.

Default value = 15.0f. Min value = 6.0f. Max value = 16.0f.

Sets the BackwardsMinArmOffset setting for this . 0 will prop arms up near his shoulders. -0.3 will place hands nearer his behind.

Default value = -0.3f. Min value = -1.0f. Max value = 0.0f.

Sets the ForwardMaxArmOffset setting for this . 0 will point arms down with angled body, 0.45 will point arms forward a bit to catch nearer the head.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

Sets the ZAxisSpinReduction setting for this . Tries to reduce the spin around the Z axis. Scale 0 - 1.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ExtraSit setting for this . Scale extra-sit value 0..1. Setting to 0 helps with arched-back issues. Set to 1 for a more alive-looking finish.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the UseHeadLook setting for this . Toggle to use the head look in this behaviour.

Default value = True.

Sets the Mask setting for this . Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = fb.

Creates a new Instance of the ElectrocuteHelper for sending a Electrocute to a given .

The to send the Electrocute to.

Sets the StunMag setting for this . The magnitude of the reaction.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the InitialMult setting for this . initialMult*stunMag = The magnitude of the 1st snap reaction (other mults are applied after this).

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the LargeMult setting for this . largeMult*stunMag = The magnitude of a random large snap reaction (other mults are applied after this).

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the LargeMinTime setting for this . min time to next large random snap (about 14 snaps with stunInterval = 0.07s).

Default value = 1.0f. Min value = 0.0f. Max value = 200.0f.

Sets the LargeMaxTime setting for this . max time to next large random snap (about 28 snaps with stunInterval = 0.07s).

Default value = 2.0f. Min value = 0.0f. Max value = 200.0f.

Sets the MovingMult setting for this . movingMult*stunMag = The magnitude of the reaction if moving(comVelMag) faster than movingThresh.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the BalancingMult setting for this . balancingMult*stunMag = The magnitude of the reaction if balancing = (not lying on the floor/ not upper body not collided) and not airborne.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the AirborneMult setting for this . airborneMult*stunMag = The magnitude of the reaction if airborne.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the MovingThresh setting for this . If moving(comVelMag) faster than movingThresh then mvingMult applied to stunMag.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the StunInterval setting for this . Direction flips every stunInterval.

Default value = 0.1f. Min value = 0.0f. Max value = 10.0f.

Sets the DirectionRandomness setting for this . The character vibrates in a prescribed way - Higher the value the more random this direction is.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the LeftArm setting for this . vibrate the leftArm.

Default value = True.

Sets the RightArm setting for this . vibrate the rightArm.

Default value = True.

Sets the LeftLeg setting for this . vibrate the leftLeg.

Default value = True.

Sets the RightLeg setting for this . vibrate the rightLeg.

Default value = True.

Sets the Spine setting for this . vibrate the spine.

Default value = True.

Sets the Neck setting for this . vibrate the neck.

Default value = True.

Sets the PhasedLegs setting for this . Legs are either in phase with each other or not.

Default value = True.

Sets the ApplyStiffness setting for this . let electrocute apply a (higher generally) stiffness to the character whilst being vibrated.

Default value = True.

Sets the UseTorques setting for this . use torques to make vibration otherwise use a change in the parts angular velocity.

Default value = True.

Sets the HipType setting for this . type of hip reaction 0=none, 1=side2side 2=steplike.

Default value = 2. Min value = 0. Max value = 2.

Creates a new Instance of the FallOverWallHelper for sending a FallOverWall to a given .

The to send the FallOverWall to.

Sets the BodyStiffness setting for this . stiffness of the body, roll up stiffness scales with this and defaults at this default value.

Default value = 9.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Damping setting for this . Damping in the effectors.

Default value = 0.5f. Min value = 0.0f. Max value = 3.0f.

Sets the MagOfForce setting for this . Magnitude of the falloverWall helper force.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the MaxDistanceFromPelToHitPoint setting for this . The maximum distance away from the pelvis that hit points will be registered.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the MaxForceDist setting for this . maximum distance between hitPoint and body part at which forces are applied to part.

Default value = 0.8f. Min value = 0.0f. Max value = 2.0f.

Sets the StepExclusionZone setting for this . Specifies extent of area in front of the wall in which balancer won't try to take another step.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the MinLegHeight setting for this . minimum height of pelvis above feet at which fallOverWall is attempted.

Default value = 0.4f. Min value = 0.1f. Max value = 2.0f.

Sets the BodyTwist setting for this . amount of twist to apply to the spine as the character tries to fling himself over the wall, provides more of a believable roll but increases the amount of lateral space the character needs to successfully flip.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the MaxTwist setting for this . max angle the character can twist before twsit helper torques are turned off.

Default value = 3.1f. Min value = 0.0f. Max value = 10.0f.

Sets the FallOverWallEndA setting for this . One end of the wall to try to fall over.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the FallOverWallEndB setting for this . One end of the wall over which we are trying to fall over.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the ForceAngleAbort setting for this . The angle abort threshold.

Default value = -0.2f.

Sets the ForceTimeOut setting for this . The force time out.

Default value = 2.0f.

Sets the MoveArms setting for this . Lift the arms up if true. Do nothing with the arms if false (eg when using catchfall arms or brace etc).

Default value = True.

Sets the MoveLegs setting for this . Move the legs if true. Do nothing with the legs if false (eg when using dynamicBalancer etc).

Default value = True.

Sets the BendSpine setting for this . Bend spine to help falloverwall if true. Do nothing with the spine if false.

Default value = True.

Sets the AngleDirWithWallNormal setting for this . Maximum angle in degrees (between the direction of the velocity of the COM and the wall normal) to start to apply forces and torques to fall over the wall.

Default value = 180.0f. Min value = 0.0f. Max value = 180.0f.

Sets the LeaningAngleThreshold setting for this . Maximum angle in degrees (between the vertical vector and a vector from pelvis to lower neck) to start to apply forces and torques to fall over the wall.

Default value = 180.0f. Min value = 0.0f. Max value = 180.0f.

Sets the MaxAngVel setting for this . if the angular velocity is higher than maxAngVel, the torques and forces are not applied.

Default value = 2.0f. Min value = -1.0f. Max value = 30.0f.

Sets the AdaptForcesToLowWall setting for this . Will reduce the magnitude of the forces applied to the character to help him to fall over wall.

Default value = False.

Sets the MaxWallHeight setting for this . Maximum height (from the lowest foot) to start to apply forces and torques to fall over the wall.

Default value = -1.0f. Min value = -1.0f. Max value = 3.0f.

Sets the DistanceToSendSuccessMessage setting for this . Minimum distance between the pelvis and the wall to send the success message. If negative doesn't take this parameter into account when sending feedback.

Default value = -1.0f. Min value = -1.0f. Max value = 3.0f.

Sets the RollingBackThr setting for this . Value of the angular velocity about the wallEgde above which the character is considered as rolling backwards i.e. goes in to fow_RollingBack state.

Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.

Sets the RollingPotential setting for this . On impact with the wall if the rollingPotential(calculated from the characters linear velocity w.r.t the wall) is greater than this value the character will try to go over the wall otherwise it won't try (fow_Aborted).

Default value = 0.3f. Min value = -1.0f. Max value = 10.0f.

Sets the UseArmIK setting for this . Try to reach the wallEdge. To configure the IK : use limitAngleBack, limitAngleFront and limitAngleTotallyBack.

Default value = False.

Sets the ReachDistanceFromHitPoint setting for this . distance from predicted hitpoint where each hands will try to reach the wall.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the MinReachDistanceFromHitPoint setting for this . minimal distance from predicted hitpoint where each hands will try to reach the wall. Used if the hand target is outside the wall Edge.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the AngleTotallyBack setting for this . max angle in degrees (between 1.the vector between two hips and 2. wallEdge) to try to reach the wall just behind his pelvis with his arms when the character is back to the wall.

Default value = 15.0f. Min value = 0.0f. Max value = 180.0f.

Creates a new Instance of the GrabHelper for sending a Grab to a given .

The to send the Grab to.

Sets the UseLeft setting for this . Flag to toggle use of left hand.

Default value = False.

Sets the UseRight setting for this . Flag to toggle the use of the Right hand.

Default value = False.

Sets the DropWeaponIfNecessary setting for this . if hasn't grabbed when weapon carrying hand is close to target, grab anyway.

Default value = False.

Sets the DropWeaponDistance setting for this . distance below which a weapon carrying hand will request weapon to be dropped.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the GrabStrength setting for this . strength in hands for grabbing (kg m/s), -1 to ignore/disable.

Default value = -1.0f. Min value = -1.0f. Max value = 10000.0f.

Sets the StickyHands setting for this . strength of cheat force on hands to pull towards target and stick to target ("cleverHandIK" strength).

Default value = 4.0f. Min value = 0.0f. Max value = 10.0f.

Sets the TurnToTarget setting for this .

Default value = .

Sets the GrabHoldMaxTimer setting for this . amount of time, in seconds, before grab automatically bails.

Default value = 100.0f. Min value = 0.0f. Max value = 1000.0f.

Sets the PullUpTime setting for this . Time to reach the full pullup strength.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the PullUpStrengthRight setting for this . Strength to pull up with the right arm. 0 = no pull up.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the PullUpStrengthLeft setting for this . Strength to pull up with the left arm. 0 = no pull up.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Pos1 setting for this . Grab pos1, right hand if not using line or surface grab.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the Pos2 setting for this . Grab pos2, left hand if not using line or surface grab.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the Pos3 setting for this .

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the Pos4 setting for this .

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the NormalR setting for this . Normal for the right grab point.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

Sets the NormalL setting for this . Normal for the left grab point.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

Sets the NormalR2 setting for this . Normal for the 2nd right grab point (if pointsX4grab=true).

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

Sets the NormalL2 setting for this . Normal for the 3rd left grab point (if pointsX4grab=true).

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

Sets the HandsCollide setting for this . Hand collisions on when grabbing (false turns off hand collisions making grab more stable esp. to grab points slightly inside geometry).

Default value = False.

Sets the JustBrace setting for this . Flag to toggle between grabbing and bracing.

Default value = False.

Sets the UseLineGrab setting for this . use the line grab, Grab along the line (x-x2).

Default value = False.

Sets the PointsX4grab setting for this . use 2 point.

Default value = False.

Sets the FromEA setting for this . use 2 point.

Default value = False.

Sets the SurfaceGrab setting for this . Toggle surface grab on. Requires pos1,pos2,pos3 and pos4 to be specified.

Default value = False.

Sets the InstanceIndex setting for this . levelIndex of instance to grab (-1 = world coordinates).

Default value = -1. Min value = -1.

Sets the InstancePartIndex setting for this . boundIndex of part on instance to grab (0 = just use instance coordinates).

Default value = 0. Min value = 0.

Sets the DontLetGo setting for this . Once a constraint is made, keep reaching with whatever hand is allowed - no matter what the angle/distance and whether or not the constraint has broken due to constraintForce GT grabStrength. mmmtodo this is a badly named parameter.

Default value = False.

Sets the BodyStiffness setting for this . stiffness of upper body. Scales the arm grab such that the armStiffness is default when this is at default value.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the ReachAngle setting for this . Angle from front at which the grab activates. If the point is outside this angle from front will not try to grab.

Default value = 2.8f. Min value = 0.0f. Max value = 3.0f.

Sets the OneSideReachAngle setting for this . Angle at which we will only reach with one hand.

Default value = 1.4f. Min value = 0.0f. Max value = 3.0f.

Sets the GrabDistance setting for this . Relative distance at which the grab starts.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the Move2Radius setting for this . Relative distance (additional to grabDistance - doesn't try to move inside grabDistance)at which the grab tries to use the balancer to move to the grab point.

Default value = 0.0f. Min value = 0.0f. Max value = 14.0f.

Sets the ArmStiffness setting for this . Stiffness of the arm.

Default value = 14.0f. Min value = 6.0f. Max value = 16.0f.

Sets the MaxReachDistance setting for this . distance to reach out towards the grab point.

Default value = 0.7f. Min value = 0.0f. Max value = 4.0f.

Sets the OrientationConstraintScale setting for this . scale torque used to rotate hands to face normals.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the MaxWristAngle setting for this . When we are grabbing the max angle the wrist ccan be at before we break the grab.

Default value = 3.1f. Min value = 0.0f. Max value = 3.2f.

Sets the UseHeadLookToTarget setting for this . if true, the character will look at targetForHeadLook after a hand grabs until the end of the behavior. (Before grabbing it looks at the grab target).

Default value = False.

Sets the LookAtGrab setting for this . if true, the character will look at the grab.

Default value = True.

Sets the TargetForHeadLook setting for this . Only used if useHeadLookToTarget is true, the target in world space to look at.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Creates a new Instance of the HeadLookHelper for sending a HeadLook to a given .

The to send the HeadLook to.

Sets the Damping setting for this . Damping of the muscles.

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the Stiffness setting for this . Stiffness of the muscles.

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

Sets the InstanceIndex setting for this . levelIndex of object to be looked at. vel parameters are ignored if this is non -1.

Default value = -1. Min value = -1.

Sets the Vel setting for this . The velocity of the point being looked at.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -100.0f. Max value = 100.0f.

Sets the Pos setting for this . The point being looked at.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the AlwaysLook setting for this . Flag to force always to look.

Default value = False.

Sets the EyesHorizontal setting for this . Keep the eyes horizontal. Use true for impact with cars. Use false if you want better look at target accuracy when the character is on the floor or leaned over alot.

Default value = True.

Sets the AlwaysEyesHorizontal setting for this . Keep the eyes horizontal. Use true for impact with cars. Use false if you want better look at target accuracy when the character is on the floor or leaned over (when not leaned over the eyes are still kept horizontal if eyesHorizontal=true ) alot.

Default value = True.

Sets the KeepHeadAwayFromGround setting for this .

Default value = False.

Sets the TwistSpine setting for this . Allow headlook to twist spine.

Default value = True.

Creates a new Instance of the HighFallHelper for sending a HighFall to a given .

The to send the HighFall to.

Sets the BodyStiffness setting for this . stiffness of body. Value feeds through to bodyBalance (synched with defaults), to armsWindmill (14 for this value at default ), legs pedal, head look and roll down stairs directly.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Bodydamping setting for this . The damping of the joints.

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the Catchfalltime setting for this . The length of time before the impact that the character transitions to the landing.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the CrashOrLandCutOff setting for this . 0.52angle is 0.868 dot//A threshold for deciding how far away from upright the character needs to be before bailing out (going into a foetal) instead of trying to land (keeping stretched out). NB: never does bailout if ignorWorldCollisions true.

Default value = 0.9f. Min value = -1.0f. Max value = 1.0f.

Sets the PdStrength setting for this . Strength of the controller to keep the character at angle aimAngleBase from vertical.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the PdDamping setting for this . Damping multiplier of the controller to keep the character at angle aimAngleBase from vertical. The actual damping is pdDamping*pdStrength*constant*angVel.

Default value = 1.0f. Min value = 0.0f. Max value = 5.0f.

Sets the ArmAngSpeed setting for this . arm circling speed in armWindMillAdaptive.

Default value = 7.9f. Min value = 0.0f. Max value = 20.0f.

Sets the ArmAmplitude setting for this . in armWindMillAdaptive.

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ArmPhase setting for this . in armWindMillAdaptive 3.1 opposite for stuntman. 1.0 old default. 0.0 in phase.

Default value = 3.1f. Min value = 0.0f. Max value = 6.3f.

Sets the ArmBendElbows setting for this . in armWindMillAdaptive bend the elbows as a function of armAngle. For stuntman true otherwise false.

Default value = True.

Sets the LegRadius setting for this . radius of legs on pedal.

Default value = 0.4f. Min value = 0.0f. Max value = 0.5f.

Sets the LegAngSpeed setting for this . in pedal.

Default value = 7.9f. Min value = 0.0f. Max value = 15.0f.

Sets the LegAsymmetry setting for this . 0.0 for stuntman. Random offset applied per leg to the angular speed to desynchronise the pedaling - set to 0 to disable, otherwise should be set to less than the angularSpeed value.

Default value = 4.0f. Min value = -10.0f. Max value = 10.0f.

Sets the Arms2LegsPhase setting for this . phase angle between the arms and legs circling angle.

Default value = 0.0f. Min value = 0.0f. Max value = 6.5f.

Sets the Arms2LegsSync setting for this . Syncs the arms angle to what the leg angle is.

Default value = . All speed/direction parameters of armswindmill are overwritten if = . If and you want synced arms/legs then armAngSpeed=legAngSpeed, legAsymmetry = 0.0 (to stop randomizations of the leg cicle speed).

Sets the ArmsUp setting for this . Where to put the arms when preparing to land. Approx 1 = above head, 0 = head height, -1 = down. LT -2.0 use catchFall arms, LT -3.0 use prepare for landing pose if Agent is due to land vertically, feet first.

Default value = -3.1f. Min value = -4.0f. Max value = 2.0f.

Sets the OrientateBodyToFallDirection setting for this . toggle to orientate to fall direction. i.e. orientate so that the character faces the horizontal velocity direction.

Default value = False.

Sets the OrientateTwist setting for this . If false don't worry about the twist angle of the character when orientating the character. If false this allows the twist axis of the character to be free (You can get a nice twisting highFall like the one in dieHard 4 when the car goes into the helicopter).

Default value = True.

Sets the OrientateMax setting for this . DEVEL parameter - suggest you don't edit it. Maximum torque the orientation controller can apply. If 0 then no helper torques will be used. 300 will orientate the character soflty for all but extreme angles away from aimAngleBase. If abs (current -aimAngleBase) is getting near 3.0 then this can be reduced to give a softer feel.

Default value = 300.0f. Min value = 0.0f. Max value = 2000.0f.

Sets the AlanRickman setting for this . If true then orientate the character to face the point from where it started falling. HighFall like the one in dieHard with Alan Rickman.

Default value = False.

Sets the FowardRoll setting for this . Try to execute a forward Roll on landing.

Default value = False.

Sets the UseZeroPose_withFowardRoll setting for this . Blend to a zero pose when forward roll is attempted.

Default value = False.

Sets the AimAngleBase setting for this . Angle from vertical the pdController is driving to ( positive = forwards).

Default value = 0.2f. Min value = -3.1f. Max value = 3.1f.

Sets the FowardVelRotation setting for this . scale to add/subtract from aimAngle based on forward speed (Internal).

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the FootVelCompScale setting for this . Scale to change to amount of vel that is added to the foot ik from the velocity (Internal).

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the SideD setting for this . sideoffset for the feet during prepareForLanding. +ve = right.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the FowardOffsetOfLegIK setting for this . Forward offset for the feet during prepareForLanding.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LegL setting for this . Leg Length for ik (Internal)//unused.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the CatchFallCutOff setting for this . 0.5angle is 0.878 dot. Cutoff to go to the catchFall ( internal) //mmmtodo do like crashOrLandCutOff.

Default value = 0.9f. Min value = -1.0f. Max value = 1.0f.

Sets the LegStrength setting for this . Strength of the legs at landing.

Default value = 12.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Balance setting for this . If true have enough strength to balance. If false not enough strength in legs to balance (even though bodyBlance called).

Default value = True.

Sets the IgnorWorldCollisions setting for this . Never go into bailout (foetal).

Default value = False.

Sets the AdaptiveCircling setting for this . stuntman type fall. Arm and legs circling direction controlled by angmom and orientation.

Default value = True.

Sets the Hula setting for this . With stuntman type fall. Hula reaction if can't see floor and not rotating fast.

Default value = True.

Sets the MaxSpeedForRecoverableFall setting for this . Character needs to be moving less than this speed to consider fall as a recoverable one.

Default value = 15.0f. Min value = 0.0f. Max value = 100.0f.

Sets the MinSpeedForBrace setting for this . Character needs to be moving at least this fast horizontally to start bracing for impact if there is an object along its trajectory.

Default value = 10.0f. Min value = 0.0f. Max value = 100.0f.

Sets the LandingNormal setting for this . Ray-cast normal doted with up direction has to be greater than this number to consider object flat enough to land on it.

Default value = 0.6f. Min value = 0.0f. Max value = 1.0f.

Creates a new Instance of the IncomingTransformsHelper for sending a IncomingTransforms to a given .

The to send the IncomingTransforms to.

InjuredOnGround.

Creates a new Instance of the InjuredOnGroundHelper for sending a InjuredOnGround to a given .

The to send the InjuredOnGround to. InjuredOnGround.

Sets the NumInjuries setting for this .

Default value = 0. Min value = 0. Max value = 2.

Sets the Injury1Component setting for this .

Default value = 0. Min value = 0.

Sets the Injury2Component setting for this .

Default value = 0. Min value = 0.

Sets the Injury1LocalPosition setting for this .

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the Injury2LocalPosition setting for this .

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the Injury1LocalNormal setting for this .

Default value = Vector3(1.0f, 0.0f, 0.0f). Min value = 0.0f. Max value = 1.0f.

Sets the Injury2LocalNormal setting for this .

Default value = Vector3(1.0f, 0.0f, 0.0f). Min value = 0.0f. Max value = 1.0f.

Sets the AttackerPos setting for this .

Default value = Vector3(1.0f, 0.0f, 0.0f). Min value = 0.0f.

Sets the DontReachWithLeft setting for this .

Default value = False.

Sets the DontReachWithRight setting for this .

Default value = False.

Sets the StrongRollForce setting for this .

Default value = False.

Carried.

Creates a new Instance of the CarriedHelper for sending a Carried to a given .

The to send the Carried to. Carried.

Dangle.

Creates a new Instance of the DangleHelper for sending a Dangle to a given .

The to send the Dangle to. Dangle.

Sets the DoGrab setting for this .

Default value = True.

Sets the GrabFrequency setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Creates a new Instance of the OnFireHelper for sending a OnFire to a given .

The to send the OnFire to.

Sets the StaggerTime setting for this . Max time for stumbling around before falling to ground.

Default value = 2.5f. Min value = 0.0f. Max value = 30.0f.

Sets the StaggerLeanRate setting for this . How quickly the character leans hips when staggering.

Default value = 0.9f. Min value = 0.0f. Max value = 1.0f.

Sets the StumbleMaxLeanBack setting for this . max the character leans hips back when staggering.

Default value = 0.4f. Min value = 0.0f. Max value = 1.5f.

Sets the StumbleMaxLeanForward setting for this . max the character leans hips forwards when staggering.

Default value = 0.5f. Min value = 0.0f. Max value = 1.5f.

Sets the ArmsWindmillWritheBlend setting for this . Blend armsWindmill with the bodyWrithe arms when character is upright.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

Sets the SpineStumbleWritheBlend setting for this . Blend spine stumble with the bodyWrithe spine when character is upright.

Default value = 0.7f. Min value = 0.0f. Max value = 1.0f.

Sets the LegsStumbleWritheBlend setting for this . Blend legs stumble with the bodyWrithe legs when character is upright.

Default value = 0.2f. Min value = 0.0f. Max value = 1.0f.

Sets the ArmsPoseWritheBlend setting for this . Blend the bodyWrithe arms with the current desired pose from on fire behaviour when character is on the floor.

Default value = 0.7f. Min value = 0.0f. Max value = 1.0f.

Sets the SpinePoseWritheBlend setting for this . Blend the bodyWrithe back with the current desired pose from on fire behaviour when character is on the floor.

Default value = 0.6f. Min value = 0.0f. Max value = 1.0f.

Sets the LegsPoseWritheBlend setting for this . Blend the bodyWrithe legs with the current desired pose from on fire behaviour when character is on the floor.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the RollOverFlag setting for this . Flag to set bodyWrithe trying to rollOver.

Default value = True.

Sets the RollTorqueScale setting for this . Scale rolling torque that is applied to character spine by bodyWrithe. Torque magnitude is calculated with the following formula: m_rollOverDirection*rollOverPhase*rollTorqueScale.

Default value = 25.0f. Min value = 0.0f. Max value = 300.0f.

Sets the PredictTime setting for this . Character pose depends on character facing direction that is evaluated from its COMTM orientation. Set this value to 0 to use no orientation prediction i.e. current character COMTM orientation will be used to determine character facing direction and finally the pose bodyWrithe is blending to. Set this value to GT 0 to predict character COMTM orientation this amout of time in seconds to the future.

Default value = 0.1f. Min value = 0.0f. Max value = 2.0f.

Default value = 8.0f. Min value = 0.0f. Max value = 60.0f.

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Creates a new Instance of the PedalLegsHelper for sending a PedalLegs to a given .

The to send the PedalLegs to.

Sets the PedalLeftLeg setting for this . pedal with this leg or not.

Default value = True.

Sets the PedalRightLeg setting for this . pedal with this leg or not.

Default value = True.

Sets the BackPedal setting for this . pedal forwards or backwards.

Default value = False.

Sets the Radius setting for this . base radius of pedal action.

Default value = 0.3f. Min value = 0.0f. Max value = 2.0f.

Sets the AngularSpeed setting for this . rate of pedaling. If adaptivePedal4Dragging is true then the legsAngularSpeed calculated to match the linear speed of the character can have a maximum value of angularSpeed (this max used to be hard coded to 13.0).

Default value = 10.0f. Min value = 0.0f. Max value = 100.0f.

Sets the LegStiffness setting for this . stiffness of legs.

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

Sets the PedalOffset setting for this . Move the centre of the pedal for the left leg up by this amount, the right leg down by this amount.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the RandomSeed setting for this . Random seed used to generate speed changes.

Default value = 100. Min value = 0.

Sets the SpeedAsymmetry setting for this . Random offset applied per leg to the angular speed to desynchronise the pedaling - set to 0 to disable, otherwise should be set to less than the angularSpeed value.

Default value = 8.0f. Min value = -10.0f. Max value = 10.0f.

Sets the AdaptivePedal4Dragging setting for this . Will pedal in the direction of travel (if backPedal = false, against travel if backPedal = true) and with an angular velocity relative to speed upto a maximum of 13(rads/sec). Use when being dragged by a car. Overrides angularSpeed.

Default value = False.

Sets the AngSpeedMultiplier4Dragging setting for this . newAngularSpeed = Clamp(angSpeedMultiplier4Dragging * linear_speed/pedalRadius, 0.0, angularSpeed).

Default value = 0.3f. Min value = 0.0f. Max value = 100.0f.

Sets the RadiusVariance setting for this . 0-1 value used to add variance to the radius value while pedalling, to desynchonize the legs' movement and provide some variety.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

Sets the LegAngleVariance setting for this . 0-1 value used to vary the angle of the legs from the hips during the pedal.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the CentreSideways setting for this . Move the centre of the pedal for both legs sideways (+ve = right). NB: not applied to hula.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the CentreForwards setting for this . Move the centre of the pedal for both legs forward (or backward -ve).

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the CentreUp setting for this . Move the centre of the pedal for both legs up (or down -ve).

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the Ellipse setting for this . Turn the circle into an ellipse. Ellipse has horizontal radius a and vertical radius b. If ellipse is +ve then a=radius*ellipse and b=radius. If ellipse is -ve then a=radius and b = radius*ellipse. 0.0 = vertical line of length 2*radius, 0.0:1.0 circle squashed horizontally (vertical radius = radius), 1.0=circle. -0.001 = horizontal line of length 2*radius, -0.0:-1.0 circle squashed vertically (horizontal radius = radius), -1.0 = circle.

Default value = 1.0f. Min value = -1.0f. Max value = 1.0f.

Sets the DragReduction setting for this . how much to account for the target moving through space rather than being static.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the Spread setting for this . Spread legs.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the Hula setting for this . If true circle the legs in a hula motion.

Default value = False.

BEHAVIOURS REFERENCED: AnimPose - allows animPose to overridebodyParts: Arms (useLeftArm, useRightArm).

Creates a new Instance of the PointArmHelper for sending a PointArm to a given .

The to send the PointArm to. BEHAVIOURS REFERENCED: AnimPose - allows animPose to overridebodyParts: Arms (useLeftArm, useRightArm).

Sets the TargetLeft setting for this . point to point to (in world space).

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the TwistLeft setting for this . twist of the arm around point direction.

Default value = 0.3f. Min value = -1.0f. Max value = 1.0f.

Sets the ArmStraightnessLeft setting for this . values less than 1 can give the arm a more bent look.

Default value = 0.8f. Min value = 0.0f. Max value = 2.0f.

Sets the UseLeftArm setting for this .

Default value = False.

Sets the ArmStiffnessLeft setting for this . stiffness of arm.

Default value = 15.0f. Min value = 6.0f. Max value = 16.0f.

Sets the ArmDampingLeft setting for this . damping value for arm used to point.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the InstanceIndexLeft setting for this . level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index.

Default value = -1. Min value = -1.

Sets the PointSwingLimitLeft setting for this . Swing limit.

Default value = 1.5f. Min value = 0.0f. Max value = 3.0f.

Sets the UseZeroPoseWhenNotPointingLeft setting for this .

Default value = False.

Sets the TargetRight setting for this . point to point to (in world space).

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the TwistRight setting for this . twist of the arm around point direction.

Default value = 0.3f. Min value = -1.0f. Max value = 1.0f.

Sets the ArmStraightnessRight setting for this . values less than 1 can give the arm a more bent look.

Default value = 0.8f. Min value = 0.0f. Max value = 2.0f.

Sets the UseRightArm setting for this .

Default value = False.

Sets the ArmStiffnessRight setting for this . stiffness of arm.

Default value = 15.0f. Min value = 6.0f. Max value = 16.0f.

Sets the ArmDampingRight setting for this . damping value for arm used to point.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the InstanceIndexRight setting for this . level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index.

Default value = -1. Min value = -1.

Sets the PointSwingLimitRight setting for this . Swing limit.

Default value = 1.5f. Min value = 0.0f. Max value = 3.0f.

Sets the UseZeroPoseWhenNotPointingRight setting for this .

Default value = False.

Creates a new Instance of the PointGunHelper for sending a PointGun to a given .

The to send the PointGun to.

Sets the EnableRight setting for this . Allow right hand to point/support?.

Default value = True.

Sets the EnableLeft setting for this . Allow right hand to point/support?.

Default value = True.

Sets the LeftHandTarget setting for this . Target for the left Hand.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the LeftHandTargetIndex setting for this . Index of the object that the left hand target is specified in, -1 is world space.

Default value = -1.

Sets the RightHandTarget setting for this . Target for the right Hand.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the RightHandTargetIndex setting for this . Index of the object that the right hand target is specified in, -1 is world space.

Default value = -1.

Sets the LeadTarget setting for this . NB: Only Applied to single handed weapons (some more work is required to have this tech on two handed weapons). Amount to lead target based on target velocity relative to the chest.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ArmStiffness setting for this . Stiffness of the arm.

Default value = 14.0f. Min value = 2.0f. Max value = 15.0f.

Sets the ArmStiffnessDetSupport setting for this . Stiffness of the arm on pointing arm when a support arm is detached from a two-handed weapon.

Default value = 8.0f. Min value = 2.0f. Max value = 15.0f.

Sets the ArmDamping setting for this . Damping.

Default value = 1.0f. Min value = 0.1f. Max value = 5.0f.

Sets the GravityOpposition setting for this . Amount of gravity opposition on pointing arm.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the GravOppDetachedSupport setting for this . Amount of gravity opposition on pointing arm when a support arm is detached from a two-handed weapon.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the MassMultDetachedSupport setting for this . Amount of mass of weapon taken into account by gravity opposition on pointing arm when a support arm is detached from a two-handed weapon. The lower the value the more the character doesn't know about the weapon mass and therefore is more affected by it.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the AllowShotLooseness setting for this . Allow shot to set a lower arm muscleStiffness than pointGun normally would.

Default value = False.

Sets the ClavicleBlend setting for this . How much of blend should come from incoming transforms 0(all IK) .. 1(all ITMs) For pointing arms only. (Support arm uses the IK solution as is for clavicles).

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ElbowAttitude setting for this . Controls arm twist. (except in pistolIK).

Default value = 0.3f. Min value = -1.0f. Max value = 1.0f.

Sets the SupportConstraint setting for this . Type of constraint between the support hand and gun. 0=no constraint, 1=hard distance constraint, 2=Force based constraint, 3=hard spherical constraint.

Default value = 1. Min value = 0. Max value = 3.

Sets the ConstraintMinDistance setting for this . For supportConstraint = 1: Support hand constraint distance will be slowly reduced until it hits this value. This is for stability and also allows the pointing arm to lead a little. Don't set lower than NM_MIN_STABLE_DISTANCECONSTRAINT_DISTANCE 0.001f.

Default value = 0.0f. Min value = 0.0f. Max value = 0.1f.

Sets the MakeConstraintDistance setting for this . For supportConstraint = 1: Minimum distance within which support hand constraint will be made.

Default value = 0.1f. Min value = 0.0f. Max value = 3.0f.

Sets the ReduceConstraintLengthVel setting for this . For supportConstraint = 1: Velocity at which to reduce the support hand constraint length.

Default value = 1.5f. Min value = 0.1f. Max value = 10.0f.

Sets the BreakingStrength setting for this . For supportConstraint = 1: strength of the supporting hands constraint (kg m/s), -1 to ignore/disable.

Default value = -1.0f. Min value = -1.0f. Max value = 1000.0f.

Sets the BrokenSupportTime setting for this . Once constraint is broken then do not try to reconnect/support for this amount of time.

Default value = 1.0f. Min value = 0.0f. Max value = 5.0f.

Sets the BrokenToSideProb setting for this . Probability that the when a constraint is broken that during brokenSupportTime a side pose will be selected.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the ConnectAfter setting for this . If gunArm has been controlled by other behaviours for this time when it could have been pointing but couldn't due to pointing only allowed if connected, change gunArm pose to something that could connect for connectFor seconds.

Default value = 0.7f. Min value = 0.0f. Max value = 5.0f.

Sets the ConnectFor setting for this . Time to try to reconnect for.

Default value = 0.6f. Min value = 0.0f. Max value = 5.0f.

Sets the OneHandedPointing setting for this . 0 = don't allow, 1= allow for kPistol(two handed pistol) only, 2 = allow for kRifle only, 3 = allow for kPistol and kRifle. Allow one handed pointing - no constraint if cant be supported . If not allowed then gunHand does not try to point at target if it cannot be supported - the constraint will be controlled by always support.

Default value = 1. Min value = 0. Max value = 3.

Sets the AlwaysSupport setting for this . Support a non pointing gunHand i.e. if in zero pose (constrain as well if constraint possible).

Default value = False.

Sets the PoseUnusedGunArm setting for this . Apply neutral pose when a gun arm isn't in use. NB: at the moment Rifle hand is always controlled by pointGun.

Default value = False.

Sets the PoseUnusedSupportArm setting for this . Apply neutral pose when a support arm isn't in use.

Default value = False.

Sets the PoseUnusedOtherArm setting for this . Apply neutral pose to the non-gun arm (otherwise it is always under the control of other behaviours or not set). If the non-gun hand is a supporting hand it is not controlled by this parameter but by poseUnusedSupportArm.

Default value = False.

Sets the MaxAngleAcross setting for this . max aiming angle(deg) sideways across body midline measured from chest forward that the character will try to point.

Default value = 90.0f. Min value = 0.0f. Max value = 180.0f.

Sets the MaxAngleAway setting for this . max aiming angle(deg) sideways away from body midline measured from chest forward that the character will try to point.

Default value = 90.0f. Min value = 0.0f. Max value = 180.0f.

Sets the FallingLimits setting for this . 0= don't apply limits. 1=apply the limits below only when the character is falling. 2 = always apply these limits (instead of applying maxAngleAcross and maxAngleAway which only limits the horizontal angle but implicity limits the updown (the limit shape is a vertical hinge).

Default value = 0. Min value = 0. Max value = 2.

Sets the AcrossLimit setting for this . max aiming angle(deg) sideways across body midline measured from chest forward that the character will try to point. i.e. for rightHanded gun this is the angle left of the midline.

Default value = 90.0f. Min value = 0.0f. Max value = 180.0f.

Sets the AwayLimit setting for this . max aiming angle(deg) sideways away from body midline measured from chest forward that the character will try to point. i.e. for rightHanded gun this is the angle right of the midline.

Default value = 90.0f. Min value = 0.0f. Max value = 180.0f.

Sets the UpLimit setting for this . max aiming angle(deg) upwards from body midline measured from chest forward that the character will try to point.

Default value = 90.0f. Min value = 0.0f. Max value = 180.0f.

Sets the DownLimit setting for this . max aiming angle(deg) downwards from body midline measured from chest forward that the character will try to point.

Default value = 45.0f. Min value = 0.0f. Max value = 180.0f.

Sets the RifleFall setting for this . Pose the rifle hand to reduce complications with collisions. 0 = false, 1 = always when falling, 2 = when falling except if falling backwards.

Default value = 0. Min value = 0. Max value = 2.

Sets the FallingSupport setting for this . Allow supporting of a rifle(or two handed pistol) when falling. 0 = false, 1 = support if allowed, 2 = support until constraint not active (don't allow support to restart), 3 = support until constraint not effective (support hand to support distance must be less than 0.15 - don't allow support to restart).

Default value = 1. Min value = 0. Max value = 3.

Sets the FallingTypeSupport setting for this . What is considered a fall by fallingSupport). Apply fallingSupport 0=never(will support if allowed), 1 = falling, 2 = falling except if falling backwards, 3 = falling and collided, 4 = falling and collided except if falling backwards, 5 = falling except if falling backwards until collided.

Default value = 0. Min value = 0. Max value = 5.

Sets the PistolNeutralType setting for this . 0 = byFace, 1=acrossFront, 2=bySide. NB: bySide is not connectible so be careful if combined with kPistol and oneHandedPointing = 0 or 2.

Default value = 0. Min value = 0. Max value = 2.

Sets the NeutralPoint4Pistols setting for this . NOT IMPLEMENTED YET KEEP=false - use pointing for neutral targets in pistol modes.

Default value = False.

Sets the NeutralPoint4Rifle setting for this . use pointing for neutral targets in rifle mode.

Default value = True.

Sets the CheckNeutralPoint setting for this . Check the neutral pointing is pointable, if it isn't then choose a neutral pose instead.

Default value = False.

Sets the Point2Side setting for this . side, up, back) side is left for left arm, right for right arm mmmmtodo.

Default value = Vector3(5.0f, -5.0f, -2.0f).

Sets the Add2WeaponDistSide setting for this . add to weaponDistance for point2Side neutral pointing (to straighten the arm).

Default value = 0.3f. Min value = -1.0f. Max value = 1000.0f.

Sets the Point2Connect setting for this . side, up, back) side is left for left arm, right for rght arm mmmmtodo.

Default value = Vector3(-1.0f, -0.9f, -0.2f).

Sets the Add2WeaponDistConnect setting for this . add to weaponDistance for point2Connect neutral pointing (to straighten the arm).

Default value = 0.0f. Min value = -1.0f. Max value = 1000.0f.

Sets the UsePistolIK setting for this . enable new ik for pistol pointing.

Default value = True.

Sets the UseSpineTwist setting for this . Use spine twist to orient chest?.

Default value = True.

Sets the UseTurnToTarget setting for this . Turn balancer to help gun point at target.

Default value = False.

Sets the UseHeadLook setting for this . Use head look to drive head?.

Default value = True.

Sets the ErrorThreshold setting for this . angular difference between pointing direction and target direction above which feedback will be generated.

Default value = 0.4f. Min value = 0.0f. Max value = 3.1f.

Sets the FireWeaponRelaxTime setting for this . Duration of arms relax following firing weapon. NB:This is clamped (0,5) in pointGun.

Default value = 0.4f. Min value = 0.0f. Max value = 5.0f.

Sets the FireWeaponRelaxAmount setting for this . Relax multiplier following firing weapon. Recovers over relaxTime.

Default value = 0.5f. Min value = 0.1f. Max value = 1.0f.

Sets the FireWeaponRelaxDistance setting for this . Range of motion for ik-based recoil.

Default value = 0.1f. Min value = 0.0f. Max value = 0.3f.

Sets the UseIncomingTransforms setting for this . Use the incoming transforms to inform the pointGun of the primaryWeaponDistance, poleVector for the arm.

Default value = True.

Sets the MeasureParentOffset setting for this . If useIncomingTransforms = true and measureParentOffset=true then measure the Pointing-from offset from parent effector, using itms - this should point the barrel of the gun to the target. This is added to the rightHandParentOffset. NB NOT used if rightHandParentEffector LT 0.

Default value = True.

Sets the LeftHandParentOffset setting for this . Pointing-from offset from parent effector, expressed in spine3's frame, x = back/forward, y = right/left, z = up/down.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the LeftHandParentEffector setting for this . 1 = Use leftShoulder. Effector from which the left hand pointing originates. ie, point from this part to the target. -1 causes default offset for active weapon mode to be applied.

Default value = -1. Min value = -1. Max value = 21.

Sets the RightHandParentOffset setting for this . Pointing-from offset from parent effector, expressed in spine3's frame, x = back/forward, y = right/left, z = up/down. This is added to the measured one if useIncomingTransforms=true and measureParentOffset=true. NB NOT used if rightHandParentEffector LT 0. Pistol(0,0,0) Rifle(0.0032, 0.0, -0.0).

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the RightHandParentEffector setting for this . 1 = Use rightShoulder.. Effector from which the right hand pointing originates. ie, point from this part to the target. -1 causes default offset for active weapon mode to be applied.

Default value = -1. Min value = -1. Max value = 21.

Sets the PrimaryHandWeaponDistance setting for this . Distance from the shoulder to hold the weapon. If -1 and useIncomingTransforms then weaponDistance is read from ITMs. weaponDistance=primaryHandWeaponDistance clamped [0.2f:m_maxArmReach=0.65] if useIncomingTransforms = false. pistol 0.60383, rifle 0.336.

Default value = -1.0f. Min value = -1.0f. Max value = 1.0f.

Sets the ConstrainRifle setting for this . Use hard constraint to keep rifle stock against shoulder?.

Default value = True.

Sets the RifleConstraintMinDistance setting for this . Rifle constraint distance. Deliberately kept large to create a flat constraint surface where rifle meets the shoulder.

Default value = 0.2f. Min value = 0.0f.

Sets the DisableArmCollisions setting for this . Disable collisions between right hand/forearm and the torso/legs.

Default value = False.

Sets the DisableRifleCollisions setting for this . Disable collisions between right hand/forearm and spine3/spine2 if in rifle mode.

Default value = False.

Seldom set parameters for pointGun - just to keep number of parameters in any message less than or equal to 64.

Creates a new Instance of the PointGunExtraHelper for sending a PointGunExtra to a given .

The to send the PointGunExtra to. Seldom set parameters for pointGun - just to keep number of parameters in any message less than or equal to 64.

Sets the ConstraintStrength setting for this . For supportConstraint = 2: force constraint strength of the supporting hands - it gets shaky at about 4.0.

Default value = 2.0f. Min value = 0.0f. Max value = 5.0f.

Sets the ConstraintThresh setting for this . For supportConstraint = 2: Like makeConstraintDistance. Force starts acting when the hands are LT 3.0*thresh apart but is maximum strength LT thresh. For comparison: 0.1 is used for reachForWound in shot, 0.25 is used in grab.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the WeaponMask setting for this . Currently unused - no intoWorldTest. RAGE bit mask to exclude weapons from ray probe - currently defaults to MP3 weapon flag.

Default value = 1024. Min value = 0.

Sets the TimeWarpActive setting for this . Is timeWarpActive enabled?.

Default value = False.

Sets the TimeWarpStrengthScale setting for this . Scale for arm and helper strength when timewarp is enabled. 1 = normal compensation.

Default value = 1.0f. Min value = 0.1f. Max value = 2.0f.

Sets the OriStiff setting for this . Hand stabilization controller stiffness.

Default value = 0.0f. Min value = 0.0f. Max value = 100.0f.

Sets the OriDamp setting for this . Hand stabilization controller damping.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the PosStiff setting for this . Hand stabilization controller stiffness.

Default value = 0.0f. Min value = 0.0f. Max value = 100.0f.

Sets the PosDamp setting for this . Hand stabilization controller damping.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Creates a new Instance of the RollDownStairsHelper for sending a RollDownStairs to a given .

The to send the RollDownStairs to.

Sets the Stiffness setting for this . Effector Stiffness. value feeds through to rollUp directly.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Damping setting for this . Effector Damping.

Default value = 1.4f. Min value = 0.0f. Max value = 4.0f.

Sets the Forcemag setting for this . Helper force strength. Do not go above 1 for a rollDownStairs/roll along ground reaction.

Default value = 0.6f. Min value = 0.0f. Max value = 10.0f.

Sets the M_useArmToSlowDown setting for this . the degree to which the character will try to stop a barrel roll with his arms.

Default value = -1.9f. Min value = -3.0f. Max value = 3.0f.

Sets the UseZeroPose setting for this . Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose.

Default value = False.

Sets the SpinWhenInAir setting for this . Applied cheat forces to spin the character when in the air, the forces are 40% of the forces applied when touching the ground. Be careful little bunny rabbits, the character could spin unnaturally in the air.

Default value = False.

Sets the M_armReachAmount setting for this . how much the character reaches with his arms to brace against the ground.

Default value = 1.4f. Min value = 0.0f. Max value = 3.0f.

Sets the M_legPush setting for this . amount that the legs push outwards when tumbling.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the TryToAvoidHeadButtingGround setting for this . Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose.

Default value = False.

Sets the ArmReachLength setting for this . the length that the arm reaches and so how much it straightens.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

Sets the CustomRollDir setting for this . pass in a custom direction in to have the character try and roll in that direction.

Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 1.0f. Max value = 1.0f.

Sets the UseCustomRollDir setting for this . pass in true to use the customRollDir parameter.

Default value = False.

Sets the StiffnessDecayTarget setting for this . The target linear velocity used to start the rolling.

Default value = 9.0f. Min value = 0.0f. Max value = 20.0f.

Sets the StiffnessDecayTime setting for this . time, in seconds, to decay stiffness down to the stiffnessDecayTarget value (or -1 to disable).

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the ZAxisSpinReduction setting for this . Tries to reduce the spin around the z axis. Scale 0 - 1.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TargetLinearVelocityDecayTime setting for this . Time for the targetlinearVelocity to decay to zero.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the TargetLinearVelocity setting for this . Helper torques are applied to match the spin of the character to the max of targetLinearVelocity and COMVelMag.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the OnlyApplyHelperForces setting for this . Don't use rollup if true.

Default value = False.

Sets the UseVelocityOfObjectBelow setting for this . scale applied cheat forces/torques to (zero) if object underneath character has velocity greater than 1.f.

Default value = False.

Sets the UseRelativeVelocity setting for this . useVelocityOfObjectBelow uses a relative velocity of the character to the object underneath.

Default value = False.

Sets the ApplyFoetalToLegs setting for this . if true, use rollup for upper body and a kind of foetal behavior for legs.

Default value = False.

Sets the MovementLegsInFoetalPosition setting for this . Only used if applyFoetalToLegs = true : define the variation of angles for the joints of the legs.

Default value = 1.3f. Min value = 0.0f. Max value = 10.0f.

Sets the MaxAngVelAroundFrontwardAxis setting for this . Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : maximal angular velocity around frontward axis of the pelvis to apply cheating torques.

Default value = 2.0f. Min value = -1.0f. Max value = 10.0f.

Sets the MinAngVel setting for this . Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : minimal angular velocity of the roll to apply cheating torques.

Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.

Sets the ApplyNewRollingCheatingTorques setting for this . if true will use the new way to apply cheating torques (like in fallOverWall), otherwise will use the old way.

Default value = False.

Sets the MaxAngVel setting for this . Only used if applyNewRollingCheatingTorques defined to true : maximal angular velocity of the roll to apply cheating torque.

Default value = 5.0f. Min value = 0.0f. Max value = 10.0f.

Sets the MagOfTorqueToRoll setting for this . Only used if applyNewRollingCheatingTorques defined to true : magnitude of the torque to roll down the stairs.

Default value = 50.0f. Min value = 0.0f. Max value = 500.0f.

Sets the ApplyHelPerTorqueToAlign setting for this . apply torque to align the body orthogonally to the direction of the roll.

Default value = False.

Sets the DelayToAlignBody setting for this . Only used if applyHelPerTorqueToAlign defined to true : delay to start to apply torques.

Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.

Sets the MagOfTorqueToAlign setting for this . Only used if applyHelPerTorqueToAlign defined to true : magnitude of the torque to align orthogonally the body.

Default value = 50.0f. Min value = 0.0f. Max value = 500.0f.

Sets the AirborneReduction setting for this . Ordinarily keep at 0.85. Make this lower if you want spinning in the air.

Default value = 0.9f. Min value = 0.0f. Max value = 1.0f.

Sets the ApplyMinMaxFriction setting for this . Pass-through to Roll Up. Controls whether or not behaviour enforces min/max friction.

Default value = True.

Sets the LimitSpinReduction setting for this . Scale zAxisSpinReduction back when rotating end-over-end (somersault) to give the body a chance to align with the axis of rotation.

Default value = False.

Creates a new Instance of the ShotHelper for sending a Shot to a given .

The to send the Shot to.

Sets the BodyStiffness setting for this . stiffness of body. Feeds through to roll_up.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the SpineDamping setting for this . stiffness of body. Feeds through to roll_up.

Default value = 1.0f. Min value = 0.1f. Max value = 2.0f.

Sets the ArmStiffness setting for this . arm stiffness.

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

Sets the InitialNeckStiffness setting for this . initial stiffness of neck after being shot.

Default value = 14.0f. Min value = 3.0f. Max value = 16.0f.

Sets the InitialNeckDamping setting for this . intial damping of neck after being shot.

Default value = 1.0f. Min value = 0.1f. Max value = 10.0f.

Sets the NeckStiffness setting for this . stiffness of neck.

Default value = 14.0f. Min value = 3.0f. Max value = 16.0f.

Sets the NeckDamping setting for this . damping of neck.

Default value = 1.0f. Min value = 0.1f. Max value = 2.0f.

Sets the KMultOnLoose setting for this . how much to add to upperbody stiffness dependent on looseness.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the KMult4Legs setting for this . how much to add to leg stiffnesses dependent on looseness.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the LoosenessAmount setting for this . how loose the character is made by a newBullet. between 0 and 1.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Looseness4Fall setting for this . how loose the character is made by a newBullet if falling.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Looseness4Stagger setting for this . how loose the upperBody of the character is made by a newBullet if staggerFall is running (and not falling). Note atm the neck ramp values are ignored in staggerFall.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the MinArmsLooseness setting for this . minimum looseness to apply to the arms.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the MinLegsLooseness setting for this . minimum looseness to apply to the Legs.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the GrabHoldTime setting for this . how long to hold for before returning to relaxed arm position.

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SpineBlendExagCPain setting for this . true: spine is blended with zero pose, false: spine is blended with zero pose if not setting exag or cpain.

Default value = False.

Sets the SpineBlendZero setting for this . spine is always blended with zero pose this much and up to 1 as the character become stationary. If negative no blend is ever applied.

Default value = 0.6f. Min value = -0.1f. Max value = 1.0f.

Sets the BulletProofVest setting for this . looseness applied to spine is different if bulletProofVest is true.

Default value = False.

Sets the AlwaysResetLooseness setting for this . looseness always reset on shotNewBullet even if previous looseness ramp still running. Except for the neck which has it's own ramp.

Default value = True.

Sets the AlwaysResetNeckLooseness setting for this . Neck looseness always reset on shotNewBullet even if previous looseness ramp still running.

Default value = True.

Sets the AngVelScale setting for this . How much to scale the angular velocity coming in from animation of a part if it is in angVelScaleMask (otherwise scale by 1.0).

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the AngVelScaleMask setting for this . Parts to scale the initial angular velocity by angVelScale (otherwize scale by 1.0).

Default value = fb.

Sets the FlingWidth setting for this . Width of the fling behaviour.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the FlingTime setting for this . Duration of the fling behaviour.

Default value = 0.6f. Min value = 0.0f. Max value = 1.0f.

Sets the TimeBeforeReachForWound setting for this . time, in seconds, before the character begins to grab for the wound on the first hit.

Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.

Sets the ExagDuration setting for this . exaggerate bullet duration (at exagMag/exagTwistMag).

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ExagMag setting for this . exaggerate bullet spine Lean magnitude.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ExagTwistMag setting for this . exaggerate bullet spine Twist magnitude.

Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.

Sets the ExagSmooth2Zero setting for this . exaggerate bullet duration ramping to zero after exagDuration.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ExagZeroTime setting for this . exaggerate bullet time spent at 0 spine lean/twist after exagDuration + exagSmooth2Zero.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the CpainSmooth2Time setting for this . conscious pain duration ramping from zero to cpainMag/cpainTwistMag.

Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.

Sets the CpainDuration setting for this . conscious pain duration at cpainMag/cpainTwistMag after cpainSmooth2Time.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the CpainMag setting for this . conscious pain spine Lean(back/Forward) magnitude (Replaces spinePainMultiplier).

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the CpainTwistMag setting for this . conscious pain spine Twist/Lean2Side magnitude Replaces spinePainTwistMultiplier).

Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.

Sets the CpainSmooth2Zero setting for this . conscious pain ramping to zero after cpainSmooth2Time + cpainDuration (Replaces spinePainTime).

Default value = 1.5f. Min value = 0.0f. Max value = 10.0f.

Sets the Crouching setting for this . is the guy crouching or not.

Default value = False.

Sets the ChickenArms setting for this . Type of reaction.

Default value = False.

Sets the ReachForWound setting for this . Type of reaction.

Default value = True.

Sets the Fling setting for this . Type of reaction.

Default value = False.

Sets the AllowInjuredArm setting for this . injured arm code runs if arm hit (turns and steps and bends injured arm).

Default value = False.

Sets the AllowInjuredLeg setting for this . when false injured leg is not bent and character does not bend to reach it.

Default value = True.

Sets the AllowInjuredLowerLegReach setting for this . when false don't try to reach for injured Lower Legs (shins/feet).

Default value = False.

Sets the AllowInjuredThighReach setting for this . when false don't try to reach for injured Thighs.

Default value = True.

Sets the StableHandsAndNeck setting for this . additional stability for hands and neck (less loose).

Default value = False.

Sets the Melee setting for this .

Default value = False.

Sets the FallingReaction setting for this . 0=Rollup, 1=Catchfall, 2=rollDownStairs, 3=smartFall.

Default value = 0. Min value = 0. Max value = 3.

Sets the UseExtendedCatchFall setting for this . keep the character active instead of relaxing at the end of the catch fall.

Default value = False.

Sets the InitialWeaknessZeroDuration setting for this . duration for which the character's upper body stays at minimum stiffness (not quite zero).

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the InitialWeaknessRampDuration setting for this . duration of the ramp to bring the character's upper body stiffness back to normal levels.

Default value = 0.4f. Min value = 0.0f. Max value = 10.0f.

Sets the InitialNeckDuration setting for this . duration for which the neck stays at intial stiffness/damping.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the InitialNeckRampDuration setting for this . duration of the ramp to bring the neck stiffness/damping back to normal levels.

Default value = 0.4f. Min value = 0.0f. Max value = 10.0f.

Sets the UseCStrModulation setting for this . if enabled upper and lower body strength scales with character strength, using the range given by parameters below.

Default value = False.

Sets the CStrUpperMin setting for this . proportions to what the strength would be normally.

Default value = 0.1f. Min value = 0.1f. Max value = 1.0f.

Sets the CStrUpperMax setting for this .

Default value = 1.0f. Min value = 0.1f. Max value = 1.0f.

Sets the CStrLowerMin setting for this .

Default value = 0.1f. Min value = 0.1f. Max value = 1.0f.

Sets the CStrLowerMax setting for this .

Default value = 1.0f. Min value = 0.1f. Max value = 1.0f.

Sets the DeathTime setting for this . time to death (HACK for underwater). If -ve don't ever die.

Default value = -1.0f. Min value = -1.0f. Max value = 1000.0f.

Send new wound information to the shot. Can cause shot to restart it's performance in part or in whole.

Creates a new Instance of the ShotNewBulletHelper for sending a ShotNewBullet to a given .

The to send the ShotNewBullet to. Send new wound information to the shot. Can cause shot to restart it's performance in part or in whole.

Sets the BodyPart setting for this . part ID on the body where the bullet hit.

Default value = 0. Min value = 0. Max value = 21.

Sets the LocalHitPointInfo setting for this . if true then normal and hitPoint should be supplied in local coordinates of bodyPart. If false then normal and hitPoint should be supplied in World coordinates.

Default value = True.

Sets the Normal setting for this . Normal coming out of impact point on character. Can be local or global depending on localHitPointInfo.

Default value = Vector3(0.0f, 0.0f, -1.0f). Min value = -1.0f. Max value = 1.0f.

Sets the HitPoint setting for this . position of impact on character. Can be local or global depending on localHitPointInfo.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the BulletVel setting for this . bullet velocity in world coordinates.

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -2000.0f. Max value = 2000.0f.

Creates a new Instance of the ShotSnapHelper for sending a ShotSnap to a given .

The to send the ShotSnap to.

Sets the Snap setting for this . Add a Snap to shot.

Default value = False.

Sets the SnapMag setting for this . The magnitude of the reaction.

Default value = 0.4f. Min value = -10.0f. Max value = 10.0f.

Sets the SnapMovingMult setting for this . movingMult*snapMag = The magnitude of the reaction if moving(comVelMag) faster than movingThresh.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the SnapBalancingMult setting for this . balancingMult*snapMag = The magnitude of the reaction if balancing = (not lying on the floor/ not upper body not collided) and not airborne.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the SnapAirborneMult setting for this . airborneMult*snapMag = The magnitude of the reaction if airborne.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the SnapMovingThresh setting for this . If moving(comVelMag) faster than movingThresh then mvingMult applied to stunMag.

Default value = 1.0f. Min value = 0.0f. Max value = 20.0f.

Sets the SnapDirectionRandomness setting for this . The character snaps in a prescribed way (decided by bullet direction) - Higher the value the more random this direction is.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the SnapLeftArm setting for this . snap the leftArm.

Default value = False.

Sets the SnapRightArm setting for this . snap the rightArm.

Default value = False.

Sets the SnapLeftLeg setting for this . snap the leftLeg.

Default value = False.

Sets the SnapRightLeg setting for this . snap the rightLeg.

Default value = False.

Sets the SnapSpine setting for this . snap the spine.

Default value = True.

Sets the SnapNeck setting for this . snap the neck.

Default value = True.

Sets the SnapPhasedLegs setting for this . Legs are either in phase with each other or not.

Default value = True.

Sets the SnapHipType setting for this . type of hip reaction 0=none, 1=side2side 2=steplike.

Default value = 0. Min value = 0. Max value = 2.

Sets the SnapUseBulletDir setting for this . Legs are either in phase with each other or not.

Default value = True.

Sets the SnapHitPart setting for this . Snap only around the wounded part//mmmmtodo check whether bodyPart doesn't have to be remembered for unSnap.

Default value = False.

Sets the UnSnapInterval setting for this . Interval before applying reverse snap.

Default value = 0.0f. Min value = 0.0f. Max value = 100.0f.

Sets the UnSnapRatio setting for this . The magnitude of the reverse snap.

Default value = 0.7f. Min value = 0.0f. Max value = 100.0f.

Sets the SnapUseTorques setting for this . use torques to make the snap otherwise use a change in the parts angular velocity.

Default value = True.

configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces.

Creates a new Instance of the ShotShockSpinHelper for sending a ShotShockSpin to a given .

The to send the ShotShockSpin to. configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces.

Sets the AddShockSpin setting for this . if enabled, add a short 'shock' of torque to the character's spine to exaggerate bullet impact.

Default value = False.

Sets the RandomizeShockSpinDirection setting for this . for use with close-range shotgun blasts, or similar.

Default value = False.

Sets the AlwaysAddShockSpin setting for this . if true, apply the shock spin no matter which body component was hit. otherwise only apply if the spine or clavicles get hit.

Default value = False.

Sets the ShockSpinMin setting for this . minimum amount of torque to add if using shock-spin feature.

Default value = 50.0f. Min value = 0.0f. Max value = 1000.0f.

Sets the ShockSpinMax setting for this . maxiumum amount of torque to add if using shock-spin feature.

Default value = 90.0f. Min value = 0.0f. Max value = 1000.0f.

Sets the ShockSpinLiftForceMult setting for this . if greater than 0, apply a force to lift the character up while the torque is applied, trying to produce a dramatic spun/twist shotgun-to-the-chest effect. this is a scale of the torque applied, so 8.0 or so would give a reasonable amount of lift.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the ShockSpinDecayMult setting for this . multiplier used when decaying torque spin over time.

Default value = 4.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ShockSpinScalePerComponent setting for this . torque applied is scaled by this amount across the spine components - spine2 recieving the full amount, then 3 and 1 and finally 0. each time, this value is used to scale it down. 0.5 means half the torque each time.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the ShockSpinMaxTwistVel setting for this . shock spin ends when twist velocity is greater than this value (try 6.0). If set to -1 does not stop.

Default value = -1.0f. Min value = -1.0f. Max value = 200.0f.

Sets the ShockSpinScaleByLeverArm setting for this . shock spin scales by lever arm of bullet i.e. bullet impact point to centre line.

Default value = True.

Sets the ShockSpinAirMult setting for this . shockSpin's torque is multipied by this value when both the character's feet are not in contact.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ShockSpin1FootMult setting for this . shockSpin's torque is multipied by this value when the one of the character's feet are not in contact.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the ShockSpinFootGripMult setting for this . shockSpin scales the torques applied to the feet by footSlipCompensation.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the BracedSideSpinMult setting for this . If shot on a side with a forward foot and both feet are on the ground and balanced, increase the shockspin to compensate for the balancer naturally resisting spin to that side.

Default value = 1.0f. Min value = 1.0f. Max value = 5.0f.

configure the fall to knees shot.

Creates a new Instance of the ShotFallToKneesHelper for sending a ShotFallToKnees to a given .

The to send the ShotFallToKnees to. configure the fall to knees shot.

Sets the FallToKnees setting for this . Type of reaction.

Default value = False.

Sets the FtkAlwaysChangeFall setting for this . Always change fall behaviour. If false only change when falling forward.

Default value = False.

Sets the FtkBalanceTime setting for this . How long the balancer runs for before fallToKnees starts.

Default value = 0.7f. Min value = 0.0f. Max value = 5.0f.

Sets the FtkHelperForce setting for this . Hip helper force magnitude - to help character lean over balance point of line between toes.

Default value = 200.0f. Min value = 0.0f. Max value = 2000.0f.

Sets the FtkHelperForceOnSpine setting for this . Helper force applied to spine3 aswell.

Default value = True.

Sets the FtkLeanHelp setting for this . Help balancer lean amount - to help character lean over balance point of line between toes. Half of this is also applied as hipLean.

Default value = 0.1f. Min value = 0.0f. Max value = 0.3f.

Sets the FtkSpineBend setting for this . Bend applied to spine when falling from knees. (+ve forward - try -0.1) (only if rds called).

Default value = 0.0f. Min value = -0.2f. Max value = 0.3f.

Sets the FtkStiffSpine setting for this . Stiffen spine when falling from knees (only if rds called).

Default value = False.

Sets the FtkImpactLooseness setting for this . Looseness (muscleStiffness = 1.01f - m_parameters.ftkImpactLooseness) applied to upperBody on knee impacts.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the FtkImpactLoosenessTime setting for this . Time that looseness is applied after knee impacts.

Default value = 0.2f. Min value = -0.1f. Max value = 1.0f.

Sets the FtkBendRate setting for this . Rate at which the legs are bent to go from standing to on knees.

Default value = 0.7f. Min value = 0.0f. Max value = 4.0f.

Sets the FtkHipBlend setting for this . Blend from current hip to balancing on knees hip angle.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the FtkLungeProb setting for this . Probability that a lunge reaction will be allowed.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the FtkKneeSpin setting for this . When on knees allow some spinning of the character. If false then the balancers' footSlipCompensation remains on and tends to keep the character facing the same way as when it was balancing.

Default value = False.

Sets the FtkFricMult setting for this . Multiplier on the reduction of friction for the feet based on angle away from horizontal - helps the character fall to knees quicker.

Default value = 1.0f. Min value = 0.0f. Max value = 5.0f.

Sets the FtkHipAngleFall setting for this . Apply this hip angle when the character starts to fall backwards when on knees.

Default value = 0.5f. Min value = -1.0f. Max value = 1.0f.

Sets the FtkPitchForwards setting for this . Hip pitch applied (+ve forward, -ve backwards) if character is falling forwards on way down to it's knees.

Default value = 0.1f. Min value = -0.5f. Max value = 0.5f.

Sets the FtkPitchBackwards setting for this . Hip pitch applied (+ve forward, -ve backwards) if character is falling backwards on way down to it's knees.

Default value = 0.1f. Min value = -0.5f. Max value = 0.5f.

Sets the FtkFallBelowStab setting for this . Balancer instability below which the character starts to bend legs even if it isn't going to fall on to it's knees (i.e. if going backwards). 0.3 almost ensures a fall to knees but means the character will keep stepping backward until it slows down enough.

Default value = 0.5f. Min value = 0.0f. Max value = 15.0f.

Sets the FtkBalanceAbortThreshold setting for this . when the character gives up and goes into a fall.

Default value = 2.0f. Min value = 0.0f. Max value = 4.0f.

Sets the FtkOnKneesArmType setting for this . Type of arm response when on knees falling forward 0=useFallArms (from RollDownstairs or catchFall), 1= armsIn, 2=armsOut.

Default value = 2. Min value = 0. Max value = 2.

Sets the FtkReleaseReachForWound setting for this . Release the reachForWound this amount of time after the knees have hit. If LT 0.0 then keep reaching for wound regardless of fall/onground state.

Default value = -1.0f. Min value = -1.0f. Max value = 5.0f.

Sets the FtkReachForWound setting for this . true = Keep reaching for wound regardless of fall/onground state. false = respect the shotConfigureArms params: reachFalling, reachFallingWithOneHand, reachOnFloor.

Default value = True.

Sets the FtkReleasePointGun setting for this . Override the pointGun when knees hit.

Default value = False.

Sets the FtkFailMustCollide setting for this . The upper body of the character must be colliding and other failure conditions met to fail.

Default value = True.

configure the shot from behind reaction.

Creates a new Instance of the ShotFromBehindHelper for sending a ShotFromBehind to a given .

The to send the ShotFromBehind to. configure the shot from behind reaction.

Sets the ShotFromBehind setting for this . Type of reaction.

Default value = False.

Sets the SfbSpineAmount setting for this . SpineBend.

Default value = 4.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SfbNeckAmount setting for this . Neck Bend.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SfbHipAmount setting for this . hip Pitch.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SfbKneeAmount setting for this . knee bend.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the SfbPeriod setting for this . shotFromBehind reaction period after being shot.

Default value = 0.7f. Min value = 0.0f. Max value = 10.0f.

Sets the SfbForceBalancePeriod setting for this . amount of time not taking a step.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the SfbArmsOnset setting for this . amount of time before applying spread out arms pose.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SfbKneesOnset setting for this . amount of time before bending knees a bit.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SfbNoiseGain setting for this . Controls additional independent randomized bending of left/right elbows.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the SfbIgnoreFail setting for this . 0=balancer fails as normal, 1= ignore backArchedBack and leanedTooFarBack balancer failures, 2= ignore backArchedBack balancer failure only, 3= ignore leanedTooFarBack balancer failure only.

Default value = 0. Min value = 0. Max value = 3.

configure the shot in guts reaction.

Creates a new Instance of the ShotInGutsHelper for sending a ShotInGuts to a given .

The to send the ShotInGuts to. configure the shot in guts reaction.

Sets the ShotInGuts setting for this . Type of reaction.

Default value = False.

Sets the SigSpineAmount setting for this . SpineBend.

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SigNeckAmount setting for this . Neck Bend.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SigHipAmount setting for this . hip Pitch.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SigKneeAmount setting for this . knee bend.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the SigPeriod setting for this . active time after being shot.

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SigForceBalancePeriod setting for this . amount of time not taking a step.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the SigKneesOnset setting for this . amount of time not taking a step.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Creates a new Instance of the ShotHeadLookHelper for sending a ShotHeadLook to a given .

The to send the ShotHeadLook to.

Sets the UseHeadLook setting for this . Use headLook. Default: looks at provided target or if this is zero - looks forward or in velocity direction. If reachForWound is enabled, switches between looking at the wound and at the default target.

Default value = False.

Sets the HeadLook setting for this . position to look at with headlook flag.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the HeadLookAtWoundMinTimer setting for this . Min time to look at wound.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the HeadLookAtWoundMaxTimer setting for this . Max time to look at wound.

Default value = 0.8f. Min value = 0.0f. Max value = 10.0f.

Sets the HeadLookAtHeadPosMaxTimer setting for this . Min time to look headLook or if zero - forward or in velocity direction.

Default value = 1.7f. Min value = 0.0f. Max value = 10.0f.

Sets the HeadLookAtHeadPosMinTimer setting for this . Max time to look headLook or if zero - forward or in velocity direction.

Default value = 0.6f. Min value = 0.0f. Max value = 10.0f.

configure the arm reactions in shot.

Creates a new Instance of the ShotConfigureArmsHelper for sending a ShotConfigureArms to a given .

The to send the ShotConfigureArms to. configure the arm reactions in shot.

Sets the Brace setting for this . blind brace with arms if appropriate.

Default value = True.

Sets the PointGun setting for this . Point gun if appropriate.

Default value = False.

Sets the UseArmsWindmill setting for this . armsWindmill if going backwards fast enough.

Default value = True.

Sets the ReleaseWound setting for this . release wound if going sideways/forward fast enough. 0 = don't. 1 = only if bracing. 2 = any default arm reaction.

Default value = 1. Min value = 0. Max value = 2.

Sets the ReachFalling setting for this . reachForWound when falling 0 = false, 1 = true, 2 = once per shot performance.

Default value = 0. Min value = 0. Max value = 2.

Sets the ReachFallingWithOneHand setting for this . Force character to reach for wound with only one hand when falling or fallen. 0= allow 2 handed reach, 1= left only if 2 handed possible, 2= right only if 2 handed possible, 3 = one handed but automatic (allows switching of hands).

Default value = 3. Min value = 0. Max value = 3.

Sets the ReachOnFloor setting for this . reachForWound when on floor - 0 = false, 1 = true, 2 = once per shot performance.

Default value = 0. Min value = 0. Max value = 2.

Sets the AlwaysReachTime setting for this . Inhibit arms brace for this amount of time after reachForWound has begun.

Default value = 0.3f. Min value = 0.0f. Max value = 10.0f.

Sets the AWSpeedMult setting for this . For armsWindmill, multiplier on character speed - increase of speed of circling is proportional to character speed (max speed of circliing increase = 1.5). eg. lowering the value increases the range of velocity that the 0-1.5 is applied over.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the AWRadiusMult setting for this . For armsWindmill, multiplier on character speed - increase of radii is proportional to character speed (max radius increase = 0.45). eg. lowering the value increases the range of velocity that the 0-0.45 is applied over.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the AWStiffnessAdd setting for this . For armsWindmill, added arm stiffness ranges from 0 to AWStiffnessAdd.

Default value = 4.0f. Min value = 0.0f. Max value = 16.0f.

Sets the ReachWithOneHand setting for this . Force character to reach for wound with only one hand. 0= allow 2 handed reach, 1= left only if 2 handed possible, 2= right only if 2 handed possible.

Default value = 0. Min value = 0. Max value = 2.

Sets the AllowLeftPistolRFW setting for this . Allow character to reach for wound with left hand if holding a pistol. It never will for a rifle. If pointGun is running this will only happen if the hand cannot point and pointGun:poseUnusedGunArm = false.

Default value = True.

Sets the AllowRightPistolRFW setting for this . Allow character to reach for wound with right hand if holding a pistol. It never will for a rifle. If pointGun is running this will only happen if the hand cannot point and pointGun:poseUnusedGunArm = false.

Default value = False.

Sets the RfwWithPistol setting for this . Override pointGun and reachForWound if desired if holding a pistol. It never will for a rifle.

Default value = False.

Sets the Fling2 setting for this . Type of reaction.

Default value = False.

Sets the Fling2Left setting for this . Fling the left arm.

Default value = True.

Sets the Fling2Right setting for this . Fling the right arm.

Default value = True.

Sets the Fling2OverrideStagger setting for this . Override stagger arms even if staggerFall:m_upperBodyReaction = true.

Default value = False.

Sets the Fling2TimeBefore setting for this . Time after hit that the fling will start (allows for a bit of loose arm movement from bullet impact.snap etc).

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the Fling2Time setting for this . Duration of the fling behaviour.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the Fling2MStiffL setting for this . MuscleStiffness of the left arm. If negative then uses the shots underlying muscle stiffness from controlStiffness (i.e. respects looseness).

Default value = 1.0f. Min value = -1.0f. Max value = 1.5f.

Sets the Fling2MStiffR setting for this . MuscleStiffness of the right arm. If negative then uses the shots underlying muscle stiffness from controlStiffness (i.e. respects looseness).

Default value = -1.0f. Min value = -1.0f. Max value = 1.5f.

Sets the Fling2RelaxTimeL setting for this . Maximum time before the left arm relaxes in the fling. It will relax automatically when the arm has completed it's bent arm fling. This is what causes the arm to straighten.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the Fling2RelaxTimeR setting for this . Maximum time before the right arm relaxes in the fling. It will relax automatically when the arm has completed it's bent arm fling. This is what causes the arm to straighten.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the Fling2AngleMinL setting for this . Min fling angle for left arm. Fling angle is random in the range fling2AngleMin:fling2AngleMax. Angle of fling in radians measured from the body horizontal sideways from shoulder. positive is up, 0 shoulder level, negative down.

Default value = -1.5f. Min value = -1.5f. Max value = 1.0f.

Sets the Fling2AngleMaxL setting for this . Max fling angle for left arm.

Default value = 1.0f. Min value = -1.5f. Max value = 1.0f.

Sets the Fling2AngleMinR setting for this . Min fling angle for right arm.

Default value = -1.5f. Min value = -1.5f. Max value = 1.0f.

Sets the Fling2AngleMaxR setting for this . Max fling angle for right arm.

Default value = 1.0f. Min value = -1.5f. Max value = 1.0f.

Sets the Fling2LengthMinL setting for this . Min left arm length. Armlength is random in the range fling2LengthMin:fling2LengthMax. Armlength maps one to one with elbow angle. (These values are scaled internally for the female character).

Default value = 0.3f. Min value = 0.3f. Max value = 0.6f.

Sets the Fling2LengthMaxL setting for this . Max left arm length.

Default value = 0.6f. Min value = 0.3f. Max value = 0.6f.

Sets the Fling2LengthMinR setting for this . Min right arm length.

Default value = 0.3f. Min value = 0.3f. Max value = 0.6f.

Sets the Fling2LengthMaxR setting for this . Max right arm length.

Default value = 0.6f. Min value = 0.3f. Max value = 0.6f.

Sets the Bust setting for this . Has the character got a bust. If so then cupBust (move bust reach targets below bust) or bustElbowLift and cupSize (stop upperArm penetrating bust and move bust targets to surface of bust) are implemented.

Default value = False.

Sets the BustElbowLift setting for this . Lift the elbows up this much extra to avoid upper arm penetrating the bust (when target hits spine2 or spine3).

Default value = 0.7f. Min value = 0.0f. Max value = 2.0f.

Sets the CupSize setting for this . Amount reach target to bust (spine2) will be offset forward by.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the CupBust setting for this . All reach targets above or on the bust will cause a reach below the bust. (specifically moves spine3 and spine2 targets to spine1). bustElbowLift and cupSize are ignored.

Default value = False.

Clone of High Fall with a wider range of operating conditions.

Creates a new Instance of the SmartFallHelper for sending a SmartFall to a given .

The to send the SmartFall to. Clone of High Fall with a wider range of operating conditions.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Bodydamping setting for this . The damping of the joints.

Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.

Sets the Catchfalltime setting for this . The length of time before the impact that the character transitions to the landing.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Default value = 0.9f. Min value = -1.0f. Max value = 1.0f.

Sets the PdStrength setting for this . Strength of the controller to keep the character at angle aimAngleBase from vertical.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the PdDamping setting for this . Damping multiplier of the controller to keep the character at angle aimAngleBase from vertical. The actual damping is pdDamping*pdStrength*constant*angVel.

Default value = 1.0f. Min value = 0.0f. Max value = 5.0f.

Sets the ArmAngSpeed setting for this . arm circling speed in armWindMillAdaptive.

Default value = 7.9f. Min value = 0.0f. Max value = 20.0f.

Sets the ArmAmplitude setting for this . in armWindMillAdaptive.

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Sets the ArmPhase setting for this . in armWindMillAdaptive 3.1 opposite for stuntman. 1.0 old default. 0.0 in phase.

Default value = 3.1f. Min value = 0.0f. Max value = 6.3f.

Sets the ArmBendElbows setting for this . in armWindMillAdaptive bend the elbows as a function of armAngle. For stuntman true otherwise false.

Default value = True.

Sets the LegRadius setting for this . radius of legs on pedal.

Default value = 0.4f. Min value = 0.0f. Max value = 0.5f.

Sets the LegAngSpeed setting for this . in pedal.

Default value = 7.9f. Min value = 0.0f. Max value = 15.0f.

Default value = 4.0f. Min value = -10.0f. Max value = 10.0f.

Sets the Arms2LegsPhase setting for this . phase angle between the arms and legs circling angle.

Default value = 0.0f. Min value = 0.0f. Max value = 6.5f.

Sets the Arms2LegsSync setting for this . Syncs the arms angle to what the leg angle is.

Default value = -3.1f. Min value = -4.0f. Max value = 2.0f.

Sets the OrientateBodyToFallDirection setting for this . toggle to orientate to fall direction. i.e. orientate so that the character faces the horizontal velocity direction.

Default value = False.

Default value = True.

Default value = 300.0f. Min value = 0.0f. Max value = 2000.0f.

Sets the AlanRickman setting for this . If true then orientate the character to face the point from where it started falling. HighFall like the one in dieHard with Alan Rickman.

Default value = False.

Sets the FowardRoll setting for this . Try to execute a forward Roll on landing.

Default value = False.

Sets the UseZeroPose_withFowardRoll setting for this . Blend to a zero pose when forward roll is attempted.

Default value = False.

Sets the AimAngleBase setting for this . Angle from vertical the pdController is driving to ( positive = forwards).

Default value = 0.2f. Min value = -3.1f. Max value = 3.1f.

Sets the FowardVelRotation setting for this . scale to add/subtract from aimAngle based on forward speed (Internal).

Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.

Sets the FootVelCompScale setting for this . Scale to change to amount of vel that is added to the foot ik from the velocity (Internal).

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the SideD setting for this . sideoffset for the feet during prepareForLanding. +ve = right.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the FowardOffsetOfLegIK setting for this . Forward offset for the feet during prepareForLanding.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LegL setting for this . Leg Length for ik (Internal)//unused.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the CatchFallCutOff setting for this . 0.5angle is 0.878 dot. Cutoff to go to the catchFall ( internal) //mmmtodo do like crashOrLandCutOff.

Default value = 0.9f. Min value = -1.0f. Max value = 1.0f.

Sets the LegStrength setting for this . Strength of the legs at landing.

Default value = 12.0f. Min value = 6.0f. Max value = 16.0f.

Sets the Balance setting for this . If true have enough strength to balance. If false not enough strength in legs to balance (even though bodyBlance called).

Default value = True.

Sets the IgnorWorldCollisions setting for this . Never go into bailout (foetal).

Default value = False.

Sets the AdaptiveCircling setting for this . stuntman type fall. Arm and legs circling direction controlled by angmom and orientation.

Default value = True.

Sets the Hula setting for this . With stuntman type fall. Hula reaction if can't see floor and not rotating fast.

Default value = True.

Sets the MaxSpeedForRecoverableFall setting for this . Character needs to be moving less than this speed to consider fall as a recoverable one.

Default value = 15.0f. Min value = 0.0f. Max value = 100.0f.

Sets the MinSpeedForBrace setting for this . Character needs to be moving at least this fast horizontally to start bracing for impact if there is an object along its trajectory.

Default value = 10.0f. Min value = 0.0f. Max value = 100.0f.

Sets the LandingNormal setting for this . Ray-cast normal doted with up direction has to be greater than this number to consider object flat enough to land on it.

Default value = 0.6f. Min value = 0.0f. Max value = 1.0f.

Sets the RdsForceMag setting for this .

Default value = 0.8f. Min value = 0.0f. Max value = 10.0f.

Sets the RdsTargetLinVeDecayTime setting for this . RDS: Time for the targetlinearVelocity to decay to zero.

Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.

Sets the RdsTargetLinearVelocity setting for this . RDS: Helper torques are applied to match the spin of the character to the max of targetLinearVelocity and COMVelMag. -1 to use initial character velocity.

Default value = 1.0f. Min value = 0.0f. Max value = 30.0f.

Sets the RdsUseStartingFriction setting for this . Start Catch Fall/RDS state with specified friction. Catch fall will overwrite based on setFallingReaction.

Default value = False.

Sets the RdsStartingFriction setting for this . Catch Fall/RDS starting friction. Catch fall will overwrite based on setFallingReaction.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the RdsStartingFrictionMin setting for this . Catch Fall/RDS starting friction minimum. Catch fall will overwrite based on setFallingReaction.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the RdsForceVelThreshold setting for this . Velocity threshold under which RDS force mag will be applied.

Default value = 10.0f. Min value = 0.0f. Max value = 100.0f.

Sets the InitialState setting for this . Force initial state (used in vehicle bail out to start SF_CatchFall (6) earlier.

Default value = 0. Min value = 0. Max value = 7.

Sets the ChangeExtremityFriction setting for this . Allow friction changes to be applied to the hands and feet.

Default value = False.

Sets the Teeter setting for this . Set up an immediate teeter in the direction of trave if initial state is SF_Balance.

Default value = False.

Sets the TeeterOffset setting for this . Offset the default Teeter edge in the direction of travel. Will need to be tweaked depending on how close to the real edge AI tends to trigger the behaviour.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the StopRollingTime setting for this . Time in seconds before ped should start actively trying to stop rolling.

Default value = 2.0f. Min value = 0.0f. Max value = 100.0f.

Sets the ReboundScale setting for this . Scale for rebound assistance. 0=off, 1=very bouncy, 2=jbone crazy Try 0.5?.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the ReboundMask setting for this . Part mask to apply rebound assistance.

Default value = uk.

Sets the ForceHeadAvoid setting for this . Force head avoid to be active during Catch Fall even when character is not on the ground.

Default value = False.

Sets the CfZAxisSpinReduction setting for this . Pass-through parameter for Catch Fall spin reduction. Increase to stop more spin. 0..1.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the SplatWhenStopped setting for this . Transition to splat state when com vel is below value, regardless of character health or fall velocity. Set to zero to disable.

Default value = 0.0f. Min value = 0.0f. Max value = 100.0f.

Sets the BlendHeadWhenStopped setting for this . Blend head to neutral pose com vel approaches zero. Linear between zero and value. Set to zero to disable.

Default value = 0.0f. Min value = 0.0f. Max value = 100.0f.

Sets the SpreadLegs setting for this . Spread legs amount for Pedal during fall.

Default value = 0.1f. Min value = -1.0f. Max value = 1.0f.

Creates a new Instance of the StaggerFallHelper for sending a StaggerFall to a given .

The to send the StaggerFall to.

Sets the ArmStiffness setting for this . stiffness of arms. catch_fall's stiffness scales with this value, but has default values when this is default.

Default value = 12.0f. Min value = 0.0f. Max value = 16.0f.

Sets the ArmDamping setting for this . Sets damping value for the arms.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineDamping setting for this .

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineStiffness setting for this .

Default value = 10.0f. Min value = 0.0f. Max value = 16.0f.

Sets the ArmStiffnessStart setting for this . armStiffness during the yanked timescale ie timeAtStartValues.

Default value = 3.0f. Min value = 0.0f. Max value = 16.0f.

Sets the ArmDampingStart setting for this . armDamping during the yanked timescale ie timeAtStartValues.

Default value = 0.1f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineDampingStart setting for this . spineDamping during the yanked timescale ie timeAtStartValues.

Default value = 0.1f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineStiffnessStart setting for this . spineStiffness during the yanked timescale ie timeAtStartValues.

Default value = 3.0f. Min value = 0.0f. Max value = 16.0f.

Sets the TimeAtStartValues setting for this . time spent with Start values for arms and spine stiffness and damping ie for whiplash efffect.

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the RampTimeFromStartValues setting for this . time spent ramping from Start to end values for arms and spine stiffness and damping ie for whiplash efffect (occurs after timeAtStartValues).

Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.

Sets the StaggerStepProb setting for this . Probability per step of time spent in a stagger step.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the StepsTillStartEnd setting for this . steps taken before lowerBodyStiffness starts ramping down by perStepReduction1.

Default value = 2. Min value = 0. Max value = 100.

Sets the TimeStartEnd setting for this . time from start of behaviour before lowerBodyStiffness starts ramping down for rampTimeToEndValues to endValues.

Default value = 100.0f. Min value = 0.0f. Max value = 100.0f.

Sets the RampTimeToEndValues setting for this . time spent ramping from lowerBodyStiffness to lowerBodyStiffnessEnd.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the LowerBodyStiffness setting for this . lowerBodyStiffness should be 12.

Default value = 13.0f. Min value = 0.0f. Max value = 16.0f.

Sets the LowerBodyStiffnessEnd setting for this . lowerBodyStiffness at end.

Default value = 8.0f. Min value = 0.0f. Max value = 16.0f.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the PerStepReduction1 setting for this . LowerBody stiffness will be reduced every step to make the character fallover.

Default value = 0.7f. Min value = 0.0f. Max value = 10.0f.

Sets the LeanInDirRate setting for this . leanInDirection will be increased from 0 to leanInDirMax linearly at this rate.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the LeanInDirMaxF setting for this . Max of leanInDirection magnitude when going forwards.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the LeanInDirMaxB setting for this . Max of leanInDirection magnitude when going backwards.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

Sets the LeanHipsMaxF setting for this . Max of leanInDirectionHips magnitude when going forwards.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the LeanHipsMaxB setting for this . Max of leanInDirectionHips magnitude when going backwards.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Lean2multF setting for this . Lean of spine to side in side velocity direction when going forwards.

Default value = -1.0f. Min value = -5.0f. Max value = 5.0f.

Sets the Lean2multB setting for this . Lean of spine to side in side velocity direction when going backwards.

Default value = -2.0f. Min value = -5.0f. Max value = 5.0f.

Sets the PushOffDist setting for this . amount stance foot is behind com in the direction of velocity before the leg tries to pushOff to increase momentum. Increase to lower the probability of the pushOff making the character bouncy.

Default value = 0.2f. Min value = -1.0f. Max value = 1.0f.

Sets the MaxPushoffVel setting for this . stance leg will only pushOff to increase momentum if the vertical hip velocity is less than this value. 0.4 seems like a good value. The higher it is the the less this functionality is applied. If it is very low or negative this can stop the pushOff altogether.

Default value = 20.0f. Min value = -20.0f. Max value = 20.0f.

Sets the HipBendMult setting for this . hipBend scaled with velocity.

Default value = 0.0f. Min value = -10.0f. Max value = 10.0f.

Sets the AlwaysBendForwards setting for this . bend forwards at the hip (hipBendMult) whether moving backwards or forwards.

Default value = False.

Sets the SpineBendMult setting for this . spine bend scaled with velocity.

Default value = 0.4f. Min value = -10.0f. Max value = 10.0f.

Sets the UseHeadLook setting for this . enable and provide a look-at target to make the character's head turn to face it while balancing, balancer default is 0.2.

Default value = True.

Sets the HeadLookPos setting for this . position of thing to look at.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the HeadLookInstanceIndex setting for this . level index of thing to look at.

Default value = -1. Min value = -1.

Sets the HeadLookAtVelProb setting for this . Probability [0-1] that headLook will be looking in the direction of velocity when stepping.

Default value = 1.0f. Min value = -1.0f. Max value = 1.0f.

Sets the TurnOffProb setting for this . Weighted Probability that turn will be off. This is one of six turn type weights.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Turn2TargetProb setting for this . Weighted Probability of turning towards headLook target. This is one of six turn type weights.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the Turn2VelProb setting for this . Weighted Probability of turning towards velocity. This is one of six turn type weights.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TurnAwayProb setting for this . Weighted Probability of turning away from headLook target. This is one of six turn type weights.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TurnLeftProb setting for this . Weighted Probability of turning left. This is one of six turn type weights.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the TurnRightProb setting for this . Weighted Probability of turning right. This is one of six turn type weights.

Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.

Sets the UseBodyTurn setting for this . enable and provide a positive bodyTurnTimeout and provide a look-at target to make the character turn to face it while balancing.

Default value = False.

Sets the UpperBodyReaction setting for this . enable upper body reaction ie blindBrace and armswindmill.

Default value = True.

Creates a new Instance of the TeeterHelper for sending a Teeter to a given .

The to send the Teeter to.

Sets the EdgeLeft setting for this . Defines the left edge point (left of character facing edge).

Default value = Vector3(39.5f, 38.9f, 21.1f). Min value = 0.0f.

Sets the EdgeRight setting for this . Defines the right edge point (right of character facing edge).

Default value = Vector3(39.5f, 39.9f, 21.1f). Min value = 0.0f.

Sets the UseExclusionZone setting for this . stop stepping across the line defined by edgeLeft and edgeRight.

Default value = True.

Sets the UseHeadLook setting for this .

Default value = True.

Sets the CallHighFall setting for this . call highFall if fallen over the edge. If false just call blended writhe (to go over the top of the fall behaviour of the underlying behaviour e.g. bodyBalance).

Default value = True.

Sets the LeanAway setting for this . lean away from the edge based on velocity towards the edge (if closer than 2m from edge).

Default value = True.

Sets the PreTeeterTime setting for this . Time-to-edge threshold to start pre-teeter (windmilling, etc).

Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.

Sets the LeanAwayTime setting for this . Time-to-edge threshold to start leaning away from a potential fall.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the LeanAwayScale setting for this . Scales stay upright lean and hip pitch.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

Sets the TeeterTime setting for this . Time-to-edge threshold to start full-on teeter (more aggressive lean, drop-and-twist, etc).

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Creates a new Instance of the UpperBodyFlinchHelper for sending a UpperBodyFlinch to a given .

The to send the UpperBodyFlinch to.

Sets the HandDistanceLeftRight setting for this . Left-Right distance between the hands.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the HandDistanceFrontBack setting for this . Front-Back distance between the hands.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the HandDistanceVertical setting for this . Vertical distance between the hands.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the BodyStiffness setting for this . stiffness of body. Value carries over to head look, spine twist.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the BodyDamping setting for this . damping value used for upper body.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the BackBendAmount setting for this . Amount to bend the back during the flinch.

Default value = -0.6f. Min value = -1.0f. Max value = 1.0f.

Sets the UseRightArm setting for this . Toggle to use the right arm.

Default value = True.

Sets the UseLeftArm setting for this . Toggle to Use the Left arm.

Default value = True.

Sets the NoiseScale setting for this . Amplitude of the perlin noise applied to the arms positions in the flicnh to the front part of the behaviour.

Default value = 0.1f. Min value = 0.0f. Max value = 1.0f.

Sets the NewHit setting for this . Relaxes the character for 1 frame if set.

Default value = True.

Sets the ProtectHeadToggle setting for this . Always protect head. Note if false then character flinches if target is in front, protects head if target is behind.

Default value = False.

Sets the DontBraceHead setting for this . don't protect head only brace from front. Turned on by bcr.

Default value = False.

Sets the ApplyStiffness setting for this . Turned of by bcr.

Default value = True.

Sets the HeadLookAwayFromTarget setting for this . Look away from target (unless protecting head then look between feet).

Default value = False.

Sets the UseHeadLook setting for this . Use headlook.

Default value = True.

Sets the TurnTowards setting for this . ve balancer turn Towards, negative balancer turn Away, 0 balancer won't turn. NB.There is a 50% chance that the character will not turn even if this parameter is set to turn.

Default value = 1. Min value = -2. Max value = 2.

Sets the Pos setting for this . position in world-space of object to flinch from.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Creates a new Instance of the YankedHelper for sending a Yanked to a given .

The to send the Yanked to.

Sets the ArmStiffness setting for this . stiffness of arms when upright.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

Sets the ArmDamping setting for this . Sets damping value for the arms when upright.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineDamping setting for this . Spine Damping when upright.

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineStiffness setting for this . Spine Stiffness when upright...

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

Sets the ArmStiffnessStart setting for this . armStiffness during the yanked timescale ie timeAtStartValues.

Default value = 3.0f. Min value = 0.0f. Max value = 16.0f.

Sets the ArmDampingStart setting for this . armDamping during the yanked timescale ie timeAtStartValues.

Default value = 0.1f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineDampingStart setting for this . spineDamping during the yanked timescale ie timeAtStartValues.

Default value = 0.1f. Min value = 0.0f. Max value = 2.0f.

Sets the SpineStiffnessStart setting for this . spineStiffness during the yanked timescale ie timeAtStartValues.

Default value = 3.0f. Min value = 0.0f. Max value = 16.0f.

Sets the TimeAtStartValues setting for this . time spent with Start values for arms and spine stiffness and damping ie for whiplash efffect.

Default value = 0.4f. Min value = 0.0f. Max value = 2.0f.

Sets the RampTimeFromStartValues setting for this . time spent ramping from Start to end values for arms and spine stiffness and damping ie for whiplash efffect (occurs after timeAtStartValues).

Default value = 0.1f. Min value = 0.0f. Max value = 2.0f.

Sets the StepsTillStartEnd setting for this . steps taken before lowerBodyStiffness starts ramping down.

Default value = 2. Min value = 0. Max value = 100.

Sets the TimeStartEnd setting for this . time from start of behaviour before lowerBodyStiffness starts ramping down by perStepReduction1.

Default value = 100.0f. Min value = 0.0f. Max value = 100.0f.

Sets the RampTimeToEndValues setting for this . time spent ramping from lowerBodyStiffness to lowerBodyStiffnessEnd.

Default value = 0.0f. Min value = 0.0f. Max value = 10.0f.

Sets the LowerBodyStiffness setting for this . lowerBodyStiffness should be 12.

Default value = 12.0f. Min value = 0.0f. Max value = 16.0f.

Sets the LowerBodyStiffnessEnd setting for this . lowerBodyStiffness at end.

Default value = 8.0f. Min value = 0.0f. Max value = 16.0f.

Sets the PerStepReduction setting for this . LowerBody stiffness will be reduced every step to make the character fallover.

Default value = 1.5f. Min value = 0.0f. Max value = 10.0f.

Sets the HipPitchForward setting for this . Amount to bend forward at the hips (+ve forward, -ve backwards). Behaviour switches between hipPitchForward and hipPitchBack.

Default value = 0.6f. Min value = -1.3f. Max value = 1.3f.

Sets the HipPitchBack setting for this . Amount to bend backwards at the hips (+ve backwards, -ve forwards). Behaviour switches between hipPitchForward and hipPitchBack.

Default value = 1.0f. Min value = -1.3f. Max value = 1.3f.

Sets the SpineBend setting for this . Bend/Twist the spine amount.

Default value = 0.7f. Min value = 0.0f. Max value = 1.0f.

Sets the FootFriction setting for this . Foot friction when standing/stepping. 0.5 gives a good slide sometimes.

Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.

Sets the TurnThresholdMin setting for this . min angle at which the turn with toggle to the other direction (actual toggle angle is chosen randomly in range min to max). If it is 1 then it will never toggle. If negative then no turn is applied.

Default value = 0.6f. Min value = -0.1f. Max value = 1.0f.

Sets the TurnThresholdMax setting for this . max angle at which the turn with toggle to the other direction (actual toggle angle is chosen randomly in range min to max). If it is 1 then it will never toggle. If negative then no turn is applied.

Default value = 0.6f. Min value = -0.1f. Max value = 1.0f.

Sets the UseHeadLook setting for this . enable and provide a look-at target to make the character's head turn to face it while balancing.

Default value = False.

Sets the HeadLookPos setting for this . position of thing to look at.

Default value = Vector3(0.0f, 0.0f, 0.0f).

Sets the HeadLookInstanceIndex setting for this . level index of thing to look at.

Default value = -1. Min value = -1.

Sets the HeadLookAtVelProb setting for this . Probability [0-1] that headLook will be looking in the direction of velocity when stepping.

Default value = -1.0f. Min value = -1.0f. Max value = 1.0f.

Sets the ComVelRDSThresh setting for this . for handsAndKnees catchfall ONLY: comVel above which rollDownstairs will start.

Default value = 2.0f. Min value = 0.0f. Max value = 20.0f.

Sets the HulaPeriod setting for this . 0.25 A complete wiggle will take 4*hulaPeriod.

Default value = 0.3f. Min value = 0.0f. Max value = 2.0f.

Sets the HipAmplitude setting for this . Amount of hip movement.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the SpineAmplitude setting for this . Amount of spine movement.

Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.

Sets the MinRelaxPeriod setting for this . wriggle relaxes for a minimum of minRelaxPeriod (if it is negative it is a multiplier on the time previously spent wriggling).

Default value = 0.3f. Min value = -5.0f. Max value = 5.0f.

Sets the MaxRelaxPeriod setting for this . wriggle relaxes for a maximum of maxRelaxPeriod (if it is negative it is a multiplier on the time previously spent wriggling).

Default value = 1.5f. Min value = -5.0f. Max value = 5.0f.

Sets the RollHelp setting for this . Amount of cheat torque applied to turn the character over.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the GroundLegStiffness setting for this . Leg Stiffness when on the ground.

Default value = 11.0f. Min value = 0.0f. Max value = 16.0f.

Sets the GroundArmStiffness setting for this . Arm Stiffness when on the ground.

Default value = 11.0f. Min value = 0.0f. Max value = 16.0f.

Sets the GroundSpineStiffness setting for this . Spine Stiffness when on the ground.

Default value = 14.0f. Min value = 0.0f. Max value = 16.0f.

Sets the GroundLegDamping setting for this . Leg Damping when on the ground.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the GroundArmDamping setting for this . Arm Damping when on the ground.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the GroundSpineDamping setting for this . Spine Damping when on the ground.

Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.

Sets the GroundFriction setting for this . Friction multiplier on bodyParts when on ground. Character can look too slidy with groundFriction = 1. Higher values give a more jerky reation but this seems timestep dependent especially for dragged by the feet.

Default value = 8.0f. Min value = 0.0f. Max value = 10.0f.

Gets the current GameVersion.

Gets the game Language.

Gets how many milliseconds the game has been open in this session

Sets the time scale of the Game.

The Time Scale, only accepts values in range 0.0f to 1.0f

Gets the total number of frames that's been rendered in this session.

Gets the current frame rate per second.

Gets the time it currently takes to render a frame, in seconds.

Gets or sets the maximum wanted level a can receive.

The maximum wanted level, only accepts values 0 to 5

Sets the wanted level multiplier

The multiplier to apply to a players wanted level

Sets a value indicating whether Police s should be visible on the Minimap

Gets or sets the radio station.

Gets the that you are controling

Gets or sets a value indicating whether to render the world with a night vision filter

Gets or sets a value indicating whether to render the world with a thermal vision filter

Gets or sets a value informing the Game Engine if a mission is in progress

if true a mission is currently active; otherwise, false

Gets or sets a value informing the Game Engine if a random event is in progress.

if true a random event is currently active; otherwise, false

Gets or a value indicating whether the cutscene is active.

if true a cutscene is currently active; otherwise, false

Gets a value indicating whether there is a Waypoint set

Gets or sets a value indicating whether the game is paused

Gets a value indicating whether there is a loading screen being displayed

Gets whether the last input was made with a GamePad or Keyboard and Mouse

Gets whether a was entered.

The to check against. true if the was just entered; otherwise, false Only works for Gamepad inputs Cheat combinations use the same system

Gets whether a cheat code was entered into the cheat text box

The name of the cheat to check. true if the cheat was just entered; otherwise, false

Gets whether a is currently pressed

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the is pressed; otherwise, false

Gets whether a was just pressed this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the was just pressed this frame; otherwise, false

Gets whether a was just released this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the was just released this frame; otherwise, false

Gets whether a is Enabled this frame and is currently pressed

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the is pressed; otherwise, false

Gets whether a is Enabled and was just pressed this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the was just pressed this frame; otherwise, false

Gets whether a is Enabled and was just released this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the was just released this frame; otherwise, false

Gets whether a is Disabled this frame and is currently pressed

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the is pressed; otherwise, false

Gets whether a is Disabled and was just pressed this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the was just pressed this frame; otherwise, false

Gets whether a is Disabled and was just released this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the was just released this frame; otherwise, false

Gets whether a is Enabled ot Disabled this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . true if the is Enabled; otherwise, false

Makes the Game Engine respond to the given Control this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The .

Makes the Game Engine ignore to the given Control this frame

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The .

Disables all s this frame.

The Input Method (0 = Mouse and Keyboard, 2 = GamePad).

Enables all s this frame.

The Input Method (0 = Mouse and Keyboard, 2 = GamePad).

Gets an Analog value of a input between -1.0f and 1.0f

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . The normalised value

Gets an Analog value of a Disabled input between -1.0f and 1.0f

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . The normalised value

Gets an value of a input.

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . The value

Override a by giving it a user defined value this frame.

The Input Method (0 = Mouse and Keyboard, 2 = GamePad). The . the value to set the control to.

Pauses or Resumes the game

if set to true Pause the game; otherwise, resume the game.

Pauses or Resumes the game clock

if set to true Pause the game clock; otherwise, resume the game clock.

Performs and automative game save

Shows the save menu enabling the user to perform a manual game save.

Determines the game language files contain a entry for the specified GXT key

The GXT key. true if GXT entry exists; otherwise, false

Returns a localised from the games language files with a specified GXT key

The GXT key. The localised if the key exists; otherwise,

Calculates a Jenkins One At A Time hash from the given which can then be used by any native function that takes a hash

The input to hash. The Jenkins hash of the

Plays a sound from the games sound files

The file the sound is stored in. The name of the sound inside the file.

Plays music from the games music files

The music file to play.

Stops playing a music file

The music file to stop.

Creates an input box for enabling a user to input text using the keyboard

The maximum length of input allowed. The of what the user entered, If the user cancelled is returned

Creates an input box for enabling a user to input text using the keyboard

The default text. The maximum length of input allowed. The of what the user entered, If the user cancelled is returned

Creates an input box for enabling a user to input text using the keyboard

The Title of the Window. The maximum length of input allowed. The of what the user entered, If the user cancelled is returned

Creates an input box for enabling a user to input text using the keyboard

The Title of the Window. The default text. The maximum length of input allowed. The of what the user entered, If the user cancelled is returned

Private unsafe version of

Returns a struct containing information about a specific tattoo. Currently only the , and are known. It's still unkown what the other values are used for or if they're even correctly offset in the byte array.

Character types 0 = Michael, 1 = Franklin, 2 = Trevor, 3 = MPMale, 4 = MPFemale Tattoo index, value between 0 and

Private (unsafe) version of

Gets the alternate prop index data for a specific prop on a specific ped. This is used to check for the 'alternate' version of a helmet with a visor for example (open/closed visor variants).

Get the hud stats for this weapon.

Get the hud stats for this weapon component.

Using a non-ASCII string has undefined behavior.

Gets the hash for this .

Returns true if this is valid.

true if this is valid; otherwise, false.

Gets a value indicating whether this is in the cd image.

true if this is in the cd image; otherwise, false.

Gets a value indicating whether this is loaded so it can be spawned.

true if this is loaded; otherwise, false.

Gets a value indicating whether the collision for this is loaded.

true if the collision is loaded; otherwise, false.

Gets a value indicating whether this is a bicycle.

true if this is a bicycle; otherwise, false.

Gets a value indicating whether this is a motorbike.

true if this is a motorbike; otherwise, false.

Gets a value indicating whether this is a boat.

true if this is a boat; otherwise, false.

Gets a value indicating whether this is a car.

true if this is a car; otherwise, false.

Gets a value indicating whether this is a cargobob.

true if this is a cargobob; otherwise, false.

Gets a value indicating whether this is a helicopter.

true if this is a helicopter; otherwise, false.

Gets a value indicating whether this is a ped.

true if this is a ped; otherwise, false.

Gets a value indicating whether this is a plane.

true if this is a plane; otherwise, false.

Gets a value indicating whether this is a prop.

true if this is a prop; otherwise, false.

Gets a value indicating whether this is a quadbike.

true if this is a quadbike; otherwise, false.

Gets a value indicating whether this is a train.

true if this is a train; otherwise, false.

Gets a value indicating whether this is a vehicle.

true if this is a vehicle; otherwise, false.

Gets the dimensions of this .

The minimum dimensions output . The maximum dimensions output .

Attempt to load this into memory.

Attempt to load this into memory for a given period of time.

The time (in milliseconds) before giving up trying to load this true if this is loaded; otherwise, false

Frees this from memory.

This is used to GET the data. The GetData() function returns the data into a usable struct for scripts to use safely.

A struct containing all ped head blend data. Used for MP (freemode) characters.

This is used to GET the data. The GetData() function returns the data into a usable struct for scripts to use safely.

Creates a class used for loading s than can be used to start s from inside the Asset

The name of the asset file which contains all the s you are wanting to start The files have the extension *.ypt in OpenIV, use the file name withouth the extension for the

Gets the name of the this file

Gets a value indicating whether this is Loaded

Use or to load the asset

Starts a Particle Effect that runs once at a given position then is destroyed.

The name of the effect. The World position where the effect is. What rotation to apply to the effect. How much to scale the size of the effect by. Which axis to flip the effect in. trueIf the effect was able to start; otherwise, false.

Starts a Particle Effect on an that runs once then is destroyed.

the name of the effect. The the effect is attached to. The offset from the to attach the effect. The rotation, relative to the , the effect has. How much to scale the size of the effect by. Which axis to flip the effect in. For a car side exahust you may need to flip in the Y Axis trueIf the effect was able to start; otherwise, false.

Starts a Particle Effect on an that runs once then is destroyed.

Creates a on an that runs looped.

The name of the Effect The the effect is attached to. The offset from the to attach the effect. The rotation, relative to the , the effect has. How much to scale the size of the effect by. Which axis to flip the effect in. For a car side exahust you may need to flip in the Y Axis. if true attempt to start this effect now; otherwise, the effect will start when is called. The represented by this that can be used to start/stop/modify this effect

Creates a on an that runs looped.

Creates a at a position that runs looped.

The name of the effect. The World position where the effect is. What rotation to apply to the effect. How much to scale the size of the effect by. Which axis to flip the effect in. if true attempt to start this effect now; otherwise, the effect will start when is called. The represented by this that can be used to start/stop/modify this effect

Sets the for all NonLooped Particle Effects

Attempts to load this into memory so it can be used for starting s.

How long in milli-seconds should the game wait while the model hasnt been loaded before giving up true if the is Loaded; otherwise, false

Tells the game we have finished using this and it can be freed from memory

Gets the Handle of this

The handle, will return -1 when the this is not active

Gets a value indicating whether this is active.

true if this is active; otherwise, false.

Deletes this .

Gets the memory address where this is located in game memory.

Gets or sets the offset. If this is attached to an , this refers to the offset from the ; otherwise, this refers to its position in World coords

Gets or Sets the rotation of this

Gets or sets the of this .

Gets or sets the size scaling factor of this

The scale, default = 1.0f; To Decrease the size use a value less than 1.0f; To Increase the size use a value greater than 1.0f;

Gets or sets which axis of this should be inverted.

Modifys parameters of this .

Name of the parameter you want to modify, these are stored inside the effect files. The new value for the parameter.

Gets the name of the asset this effect is stored in.

Gets the name of this effect.

Gets or sets the this is attached to.

Gets or sets the that this is attached to.

Starts this .

true if this was sucessfully started; otherwise, false.

Creates a copy of this to another to simplify applying the same effect to many Entities.

The to copy to. An that has all the same properties as this instance, but for a different .

Creates a copy of this to another to simplify applying the same effect to many Entities.

The to copy to. An that has all the same properties as this instance, but for a different .

Starts this .

true if this was sucessfully started; otherwise, false.

Creates a copy of this to another position to simplify applying the same effect to many positions.

The position to copy to. A that has all the same properties as this instance, but for a different position.

Get the headblend data from this .

A struct containing all headblend data from a mp ped.

Gets the unsafe headblend struct and converts it into a safe struct and returns that struct.

A struct.

Gets or sets how much money this is carrying.

Gets the gender of this . Note this does not seem to work correctly for all peds.

Gets or sets how much Armor this is wearing.

if you need to get or set the value strictly, use instead.

Gets or sets how much Armor this is wearing in float.

Gets or sets how accurate this s shooting ability is.

The accuracy from 0 to 100, 0 being very innacurate, 100 being perfectly accurate.

Opens a list of that this can carry out.

Gets the stage of the this is currently executing.

Opens a list of Helpers which can be applied to this .

Gets a collection of all this s s.

Opens a list of clothing and prop configurations that this can wear.

Gets the vehicle weapon this is using. The vehicle weapon, returns if this isnt using a vehicle weapon.

Gets the last this used.

returns null if the last vehicle doesn't exist.

Gets the current this is using.

returns null if this isn't in a .

Gets the this is trying to enter.

returns null if this isn't trying to enter a .

Gets the PedGroup this is in.

Gets or sets the how much sweat should be rendered on this .

The sweat from 0 to 100, 0 being no sweat, 100 being saturated.

Sets how high up on this s body water should be visible.

The height ranges from 0.0f to 1.99f, 0.0f being no water visible, 1.99f being covered in water.

Sets the voice to use when this speaks.

Sets the rate this will shoot at.

The shoot rate from 0.0f to 1000.0f, 100.0f is the default value.

Gets a value indicating whether this was killed by a stealth attack.

true if this was killed by stealth; otherwise, false.

Gets a value indicating whether this was killed by a takedown.

true if this was killed by a takedown; otherwise, false.

Gets the this is in.

The this is in if this is in a ; otherwise, .

Gets a value indicating whether this is jumping out of their vehicle.

true if this is jumping out of their vehicle; otherwise, false.

Sets a value indicating whether this will stay in the vehicle when the driver gets jacked.

true if stays in vehicle when jacked; otherwise, false.

Sets the maximum driving speed this can drive at.

Gets or sets the injury health threshold for this . The ped is considered injured when its health drops below this value.

The injury health threshold. Should be below .

Gets or sets the fatal injury health threshold for this . The ped is considered dead when its health drops below this value.

The fatal injury health threshold. Should be below . Note on player controlled peds: One of the game scripts will kill the player when their health drops below 100, regardless of this setting.

Gets a value indicating whether this is human.

true if this is human; otherwise, false.

Sets whether permanent events are blocked for this . If permanent events are blocked, this will only do as it's told, and won't flee when shot at, etc.

true if permanent events are blocked; otherwise, false.

Sets the status of the vision cone of the AI Blip

Sets the status if the AI Blip is forced on the map

Sets the gang id of the AI Blip

Sets the sprite of the AI Blip

Sets the range of the AI Blip

Enables an AI Blip for this

Blip sprite for the AI Blip

Enables an AI Blip for this with color

Blip sprite for the AI Blip Color for the AI Blip (see the docs (blip colors))

Disables the AI Blip of this

Checks if this has an AI Blip

True if the ped has an AI Blip

Returns the blip handle of this AI Blip

Blip Handle

Returns the AI Blip as a

A object

Determines whether this exists.

true if this exists; otherwise, false

Determines whether the exists.

The to check. true if the exists; otherwise, false

Gets the with the specified bone name.

Name of the bone.

Gets the at the specified bone index.

The bone index.

Gets the with the specified boneId.

The boneId.

Gets the last damaged Bone for this .

Clears the last damage a bone on this received.

Gets the this is controling.

Gets the of this

Gets the name of this .

Gets or sets how much money this has. Only works if current player is , or

Gets or sets the wanted level for this .

Gets or sets the wanted center position for this .

The place in world coords where the police think this is.

Gets or sets the maximum amount of armor this can carry.

Gets or sets the primary parachute tint for this .

Gets or sets the reserve parachute tint for this .

Sets a value indicating whether this can leave a parachute smoke trail.

true if this can leave a parachute smoke trail; otherwise, false.

Gets or sets the color of the parachute smoke trail for this .

The color of the parachute smoke trail for this .

Gets a value indicating whether this is alive.

true if this is alive; otherwise, false.

Gets a value indicating whether this is dead.

true if this is dead; otherwise, false.

Gets a value indicating whether this is aiming.

true if this is aiming; otherwise, false.

Gets a value indicating whether this is climbing.

true if this is climbing; otherwise, false.

Gets a value indicating whether this is riding a train.

true if this is riding a train; otherwise, false.

Gets a value indicating whether this is pressing a horn.

true if this is pressing a horn; otherwise, false.

Gets a value indicating whether this is playing.

true if this is playing; otherwise, false.

Gets or sets a value indicating whether this is invincible.

true if this is invincible; otherwise, false.

Sets a value indicating whether this is ignored by the police.

true if this is ignored by the police; otherwise, false.

Sets a value indicating whether this is ignored by everyone.

true if this is ignored by everyone; otherwise, false.

Sets a value indicating whether cops will be dispatched for this

true if cops will be dispatched; otherwise, false.

Sets a value indicating whether this can use cover.

true if this can use cover; otherwise, false.

Gets a value indicating whether this can start a mission.

true if this can start a mission; otherwise, false.

Sets a value indicating whether this can control ragdoll.

true if this can control ragdoll; otherwise, false.

Gets or sets a value indicating whether this can control its .

true if this can control its ; otherwise, false.

Attempts to change the of this .

The to change this to. true if the change was sucessful; otherwise, false.

Gets how long this can remain sprinting for.

Gets how much sprint stamina this currently has.

Gets how long this can stay underwater before they start losing health.

Gets a value indicating whether this is using their special ability.

true if this is using their special ability; otherwise, false.

Gets or sets a value indicating whether this can use their special ability.

true if this can use their special ability; otherwise, false.

Charges the special ability for this .

The absolute amount.

Charges the special ability for this .

The amount between 0.0f and 1.0f

Refills the special ability for this .

Depletes the special ability for this .

Gets the last this used.

returns null if the last vehicle doesn't exist.

Determines whether this is targetting the specified .

The to check. true if this is targetting the specified ; otherwise, false.

Gets a value indicating whether this is targetting anything.

true if this is targetting anything; otherwise, false.

Gets the this is targetting.

The if this is targetting any ; otherwise, null

Sets a value indicating whether ths player is forced to aim.

true to make the player always be aiming; otherwise, false.

Prevents this firing this frame.

Sets the run speed mult for this this this frame. (THIS NAME IS WRONG, SHOULD NOT BE CALLED EVERY FRAME).

The factor - min: 0.0f, default: 1.0f, max: 1.499f.

Sets the swim speed mult for this this this frame. (THIS NAME IS WRONG, SHOULD NOT BE CALLED EVERY FRAME).

The factor - min: 0.0f, default: 1.0f, max: 1.499f.

Makes this shoot fire bullets this frame.

Makes this shoot explosive bullets this frame.

Makes this have an explosive melee attack this frame.

Lets this jump really high this frame.

Blocks this from entering any this frame.

Only lets this enter a specific this frame.

The this is allowed to enter.

Determines whether this exists.

true if this exists; otherwise, false

Determines whether the exists.

The to check. true if the exists; otherwise, false

Gets the this raycast collided with. Returns null if the raycast didnt collide with any .

Gets the world coordinates where this raycast collided. Returns if the raycast didnt collide with anything.

Gets the normal of the surface where this raycast collided. Returns if the raycast didnt collide with anything.

Gets a value indicating whether this raycast collided with anything.

Gets a value indicating whether this raycast collided with any .

Gets a value indicating the material type of the collision.

Looks at the specified .

Must be greater than 0 for the ped to actually move their head.

Looks at the specified

Must be greater than 0 for the ped to actually move their head.

Looks at the specified position.

Must be greater than 0 for the ped to actually move their head.

Looks at the specified

Must be greater than 0 for the ped to actually move their head.

Gets the display name of this . Use to get the localized name.

Gets the localized name of this

Gets the display name of this s . Use to get the localized class name.

Gets the localized name of this s .

Gets the class of this .

Gets or sets this s body health.

Gets or sets this engine health.

Gets or sets this petrol tank health.

Gets or sets this fuel level.

Gets or sets a value indicating whether this s engine is running.

true if this s engine is running; otherwise, false.

Gets or sets a value indicating whether this s engine is currently starting.

true if this s engine is starting; otherwise, false.

Turns this s radio on or off

Sets this s radio station.

Gets or sets this s speed.

The speed in m/s.

Gets the speed the drive wheels are turning at, This is the value used for the dashboard speedometers(after being converted to mph).

Gets the acceleration of this .

Gets or sets the current RPM of this .

The current RPM between 0.0f and 1.0f.

Gets the current gear this is using.

Gets the steering angle of this .

The steering angle in degrees.

Gets or sets the steering scale of this .

Gets a value indicating whether this has forks.

true if this has forks; otherwise, false.

Sets a value indicating whether this has an alarm set.

true if this has an alarm set; otherwise, false.

Gets a value indicating whether this is sounding its alarm.

true if this is sounding its alarm; otherwise, false.

Gets or sets time left before this alarm stops. If greater than zero, the vehicle alarm will be sounding. the value is up to 65534.

The time left before this alarm stops.

Starts sounding the alarm on this .

Gets a value indicating whether this has a siren.

true if this has a siren; otherwise, false.

Gets or sets a value indicating whether this has its siren turned on.

true if this has its siren turned on; otherwise, false.

Sets a value indicating whether the siren on this plays sounds.

true if the siren on this plays sounds; otherwise, false.

Sounds the horn on this .

The duration to sound the horn for.

Gets or sets a value indicating whether this is wanted by the police.

true if this is wanted by the police; otherwise, false.

Gets or sets a value indicating whether peds can use this for cover.

true if peds can use this for cover; otherwise, false.

Gets or sets a value indicating whether this drops money when destroyed.

true if this drops money when destroyed; otherwise, false.

Gets or sets a value indicating whether this was previously owned by a .

true if this was previously owned by a ; otherwise, false.

Gets or sets a value indicating whether this needs to be hotwired to start.

true if this needs to be hotwired to start; otherwise, false.

Gets or sets a value indicating whether this has its lights on.

true if this has its lights on; otherwise, false.

Gets or sets a value indicating whether this has its high beams on.

true if this has its high beams on; otherwise, false.

Gets or sets a value indicating whether this has its interior lights on.

true if this has its interior lights on; otherwise, false.

Gets or sets a value indicating whether this has its search light on.

true if this has its search light on; otherwise, false.

Gets or sets a value indicating whether this has its taxi light on.

true if this has its taxi light on; otherwise, false.

Gets or sets a value indicating whether this has its left indicator light on.

true if this has its left indicator light on; otherwise, false.

Gets or sets a value indicating whether this has its right indicator light on.

true if this has its right indicator light on; otherwise, false.

Sets a value indicating whether the Handbrake on this is forced on.

true if the Handbrake on this is forced on; otherwise, false.

Gets or sets a value indicating whether this has its brake light on.

true if this has its brake light on; otherwise, false.

Gets whether or not the engine is on fire and losing health rapdily.

Gets or sets the suspension height of this .

The suspension height.

Determines whether this exists.

true if this exists; otherwise, false

Determines whether the exists.

The to check. true if the exists; otherwise, false

Gets the data from this .

Gets or sets the current date and time in the GTA World.

The current date and time.

Gets or sets the current time of day in the GTA World.

The current time of day

Sets a value indicating whether lights in the should be rendered.

true if blackout; otherwise, false.

Gets or sets the current Cloud Hat.

Gets or sets the current Cloud Hat opacity. On a scale of 0.0 to 1.0.

Gets or sets the weather.

The weather.

Gets or sets the next weather.

The next weather.

Gets or sets the weather transition.

The weather transition.

Transitions to weather. Duration is 45f in most scripts.

The weather. The duration.

Sets the gravity level for all objects.

The gravity level: 9.8f - Default gravity. 2.4f - Moon gravity. 0.1f - Very low gravity. 0.0f - No gravity.

Gets or sets the rendering camera.

The rendering . Setting to null sets the rendering to .

Destroys all user created s.

Gets or sets the waypoint position.

The coordinates of the Waypoint Returns an empty if a waypoint hasn't been set If the game engine cant extract height information the Z component will be 0.0f

Gets the waypoint blip.

The coordinates of the Waypoint Returns null if a waypoint hasn't been set

Removes the waypoint.

Gets the straight line distance between 2 positions.

The origin. The destination. The distance

Calculates the travel distance using roads and paths between 2 positions.

The origin. The destination. The travel distance

Gets the height of the ground at a given position.

The position. The height measured in meters

Gets the height of the ground at a given position.

The position. The height measured in meters

Gets an array of all the s on the map with a given .

The blip types to include, leave blank to get all s.

Gets an array of all the s on the map.

Gets the closest to a given position in the World.

The position to check against. The spatials to check. The closest to the

Gets the closest to a given position in the World ignoring height.

The position to check against. The spatials to check. The closest to the

Gets the nearest safe coordinate to position a .

The position to check around. if set to true Only find positions on the sidewalk. The flags.

Gets the next position on the street where a can be placed.

The position to check around. if set to true only find positions that dont already have a vehicle in them.

Gets the next position on the street where a can be placed.

The position to check around. if set to true only find positions that dont already have a vehicle in them.

Gets the next position on the street where a can be placed.

The position to check around.

Gets the next position on the street where a can be placed.

The position to check around.

Gets the localized name of the a zone in the map.

The position on the map.

Gets the localized name of the a zone in the map.

The position on the map.

Gets the display name of the a zone in the map. Use to convert to the localized name.

The position on the map.

Gets the display name of the a zone in the map. Use to convert to the localized name.

The position on the map.

Creates a at the given position on the map.

The position of the blip on the map.

Creates a for a circular area at the given position on the map.

The position of the blip on the map. The radius of the area on the map.

Creates a , use to switch to this camera

The position of the camera. The rotation of the camera. The field of view of the camera.

Spawns a of the given at the position and heading specified.

The of the . The position to spawn the at. The heading of the . returns null if the could not be spawned

Spawns a of a random at the position specified.

The position to spawn the at.

Spawns a of the given at the position and heading specified.

The of the . The position to spawn the at. The heading of the . returns null if the could not be spawned

Spawns a of a random at the position specified.

The position to spawn the at. The heading of the . returns null if the could not be spawned

Spawns a of the given at the position specified.

The of the . The position to spawn the at. if set to true the will have physics; otherwise, it will be static. if set to true place the prop on the ground nearest to the . returns null if the could not be spawned

Spawns a of the given at the position specified.

The of the . The position to spawn the at. The rotation of the . if set to true the will have physics; otherwise, it will be static. if set to true place the prop on the ground nearest to the . returns null if the could not be spawned

Spawns a of the given at the position specified without any offset.

The of the . The position to spawn the at. if set to true the will have physics; otherwise, it will be static. returns null if the could not be spawned

Spawns a of the given at the position specified without any offset.

The of the . The position to spawn the at. The rotation of the . if set to true the will have physics; otherwise, it will be static. returns null if the could not be spawned

Creates a in the world.

The to display inside the . The position in the World. The position in the world where this should point. The radius of the . The color of the . returns null if the could not be created

Creates a in the world.

The to display inside the . The position in the World. The position in the world where this should point. The radius of the . The color of the . returns null if the could not be created

Spawns a .

The type of . The position of the . The rotation of the . The length of the . The minimum length of the . if set to true the will break if shot.

Fires a single bullet in the world

Where the bullet is fired from. Where the bullet is fired to. The who fired the bullet, leave null for no one. The weapon that the bullet is fired from. The damage the bullet will cause. The speed, only affects projectile weapons, leave -1 for default.

Creates an explosion in the world

The position of the explosion. The type of explosion. The radius of the explosion. The amount of camera shake to apply to nearby cameras. The who caused the explosion, leave null if no one caused the explosion. if set to true explosion can be heard. if set to true explosion is invisible.

Creates a with the given name.

The name of the relationship group.

Creates a raycast between 2 points.

The source of the raycast. The target of the raycast. What type of objects the raycast should intersect with. Specify an that the raycast should ignore, leave null for no entities ignored.

Creates a raycast between 2 points.

The source of the raycast. The direction of the raycast. How far the raycast should go out to. What type of objects the raycast should intersect with. Specify an that the raycast should ignore, leave null for no entities ignored.

Creates a 3D raycast between 2 points.

The source of the raycast. The target of the raycast. The radius of the raycast. What type of objects the raycast should intersect with. Specify an that the raycast should ignore, leave null for no entities ignored.

Creates a 3D raycast between 2 points.

The source of the raycast. The direction of the raycast. The radius of the raycast. How far the raycast should go out to. What type of objects the raycast should intersect with. Specify an that the raycast should ignore, leave null for no entities ignored.

Determines where the crosshair intersects with the world.

A containing information about where the crosshair intersects with the world.

Determines where the crosshair intersects with the world.

Prevent the raycast detecting a specific . A containing information about where the crosshair intersects with the world.

Draws a marker in the world, this needs to be done on a per frame basis

The type of marker. The position of the marker. The direction the marker points in. The rotation of the marker. The amount to scale the marker by. The color of the marker. if set to true the marker will bob up and down. if set to true the marker will always face the camera, regardless of its rotation. if set to true rotates only on the y axis(heading). Name of texture dictionary to load the texture from, leave null for no texture in the marker. Name of texture inside the dictionary to load the texture from, leave null for no texture in the marker. if set to true draw on any that intersects the marker.

Draws light around a region.

The position to center the light around. The color of the light. How far the light should extend to. The intensity: 0.0f being no intensity, 1.0f being full intensity.

Stops all particle effects in a range.

The position in the world to stop particle effects. The maximum distance from the to stop particle effects.

Provides fast reading and writing of generic structures to a memory location using IL emitted functions.

Retrieve a pointer to the passed generic structure type. This is achieved by emitting a to retrieve a pointer to the structure.

A pointer to the provided structure in memory.

Loads the generic value type from a pointer. This is achieved by emitting a that returns the value in the memory location as a . The equivalent non-generic C# code:


            unsafe MyStruct ReadFromPointer(byte* pointer)
            {
                return *(MyStruct*)pointer;
            }

Any value/structure type Unsafe pointer to memory to load the value from The newly loaded value

Writes the generic value type to the location specified by a pointer. This is achieved by emitting a that copies the value from the referenced structure into the specified memory location. There is no exact equivalent possible in C#, the closest possible (generates the same IL) is the following code:


            unsafe void WriteToPointer(ref SharedHeader dest, ref SharedHeader src)
            {
                dest = src;
            }

Retrieve the cached size of a structure

Caches the size by type

Reads a number of elements from a memory location into the provided buffer starting at the specified index.

The structure type The destination buffer. The source memory location. The start index within . The number of elements to read.

Writes a number of elements to a memory location from the provided buffer starting at the specified index.

The structure type The destination memory location. The source buffer. The start index within . The number of elements to write.

Emits optimized IL for the reading and writing of structures to/from memory. For a 32-byte structure with 1 million iterations: The method performs approx. 20x faster than (8ms vs 160ms), and about 1.6x slower than the non-generic equivalent (8ms vs 5ms) The method performs approx. 8x faster than (4ms vs 34ms).

Delegate that returns a pointer to the provided structure. Use with extreme caution.

Delegate for loading a structure from the specified memory address

Delegate for writing a structure to the specified memory address

The delegate for the generated IL to retrieve a pointer to the structure

The delegate for the generated IL to retrieve a structure from a specified memory address.

The delegate for the generated IL to store a structure at the specified memory address.

Cached size of T as determined by .

Performs once of type compatibility check.

Thrown if the type T is incompatible

The value for which all absolute numbers smaller than are considered equal to zero.

A value specifying the approximation of π which is 180 degrees.

A value specifying the approximation of 2π which is 360 degrees.

Mathematical term for 2π, which is equivalent to 360 degrees.

A value specifying the approximation of π/2 which is 90 degrees.

A value specifying the approximation of π/4 which is 45 degrees.

Checks if a and b are almost equals, taking into account the magnitude of floating point numbers (unlike method). See Remarks. See remarks.

The left value to compare. The right value to compare. true if a almost equal to b, false otherwise The code is using the technique described by Bruce Dawson in Comparing Floating point numbers 2012 edition.

Determines whether the specified value is close to zero (0.0f).

The floating value. true if the specified value is close to zero (0.0f); otherwise, false.

Determines whether the specified value is close to one (1.0f).

The floating value. true if the specified value is close to one (1.0f); otherwise, false.

Checks if a - b are almost equals within a float epsilon.

The left value to compare. The right value to compare. Epsilon value true if a almost equal to b within a float epsilon, false otherwise

Converts revolutions to degrees.

The value to convert. The converted value.

Converts revolutions to radians.

The value to convert. The converted value.

Converts revolutions to gradians.

The value to convert. The converted value.

Converts degrees to revolutions.

The value to convert. The converted value.

Converts degrees to radians.

The value to convert. The converted value.

Converts radians to revolutions.

The value to convert. The converted value.

Converts radians to gradians.

The value to convert. The converted value.

Converts gradians to revolutions.

The value to convert. The converted value.

Converts gradians to degrees.

The value to convert. The converted value.

Converts gradians to radians.

The value to convert. The converted value.

Converts radians to degrees.

The value to convert. The converted value.

Clamps the specified value.

The value. The min. The max. The result of clamping a value between min and max

Clamps the specified value.

The value. The min. The max. The result of clamping a value between min and max

Interpolates between two values using a linear function by a given amount.

See http://www.encyclopediaofmath.org/index.php/Linear_interpolation and http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/ Value to interpolate from. Value to interpolate to. Interpolation amount. The result of linear interpolation of values based on the amount.

Interpolates between two values using a linear function by a given amount.

Performs smooth (cubic Hermite) interpolation between 0 and 1.

See https://en.wikipedia.org/wiki/Smoothstep Value between 0 and 1 indicating interpolation amount.

Performs a smooth(er) interpolation between 0 and 1 with 1st and 2nd order derivatives of zero at endpoints.

See https://en.wikipedia.org/wiki/Smoothstep Value between 0 and 1 indicating interpolation amount.

Calculates the modulo of the specified value.

The value. The modulo. The result of the modulo applied to value

Calculates the modulo 2*PI of the specified value.

The value. The result of the modulo applied to value

Wraps the specified value into a range [min, max]

The value to wrap. The min. The max. Result of the wrapping. Is thrown when is greater than .

Wraps the specified value into a range [min, max[

The value. The min. The max. Result of the wrapping. Is thrown when is greater than .

Gauss function.

Curve amplitude. Position X. Position Y Radius X. Radius Y. Curve sigma X. Curve sigma Y. The result of Gaussian function.

Gauss function.

Curve amplitude. Position X. Position Y Radius X. Radius Y. Curve sigma X. Curve sigma Y. The result of Gaussian function.

Represents a 4x4 mathematical matrix.

A with all of its components set to zero.

The identity .

Value at row 1 column 1 of the matrix.

Value at row 1 column 2 of the matrix.

Value at row 1 column 3 of the matrix.

Value at row 1 column 4 of the matrix.

Value at row 2 column 1 of the matrix.

Value at row 2 column 2 of the matrix.

Value at row 2 column 3 of the matrix.

Value at row 2 column 4 of the matrix.

Value at row 3 column 1 of the matrix.

Value at row 3 column 2 of the matrix.

Value at row 3 column 3 of the matrix.

Value at row 3 column 4 of the matrix.

Value at row 4 column 1 of the matrix.

Value at row 4 column 2 of the matrix.

Value at row 4 column 3 of the matrix.

Value at row 4 column 4 of the matrix.

Gets or sets the up of the matrix; that is M21, M22, and M23.

Gets or sets the down of the matrix; that is -M21, -M22, and -M23.

Gets or sets the right of the matrix; that is M11, M12, and M13.

Gets or sets the left of the matrix; that is -M11, -M12, and -M13.

Gets or sets the forward of the matrix; that is -M31, -M32, and -M33.

Gets or sets the backward of the matrix; that is M31, M32, and M33.

Initializes a new instance of the struct.

The value that will be assigned to all components.

Initializes a new instance of the struct.

The value to assign at row 1 column 1 of the matrix. The value to assign at row 1 column 2 of the matrix. The value to assign at row 1 column 3 of the matrix. The value to assign at row 1 column 4 of the matrix. The value to assign at row 2 column 1 of the matrix. The value to assign at row 2 column 2 of the matrix. The value to assign at row 2 column 3 of the matrix. The value to assign at row 2 column 4 of the matrix. The value to assign at row 3 column 1 of the matrix. The value to assign at row 3 column 2 of the matrix. The value to assign at row 3 column 3 of the matrix. The value to assign at row 3 column 4 of the matrix. The value to assign at row 4 column 1 of the matrix. The value to assign at row 4 column 2 of the matrix. The value to assign at row 4 column 3 of the matrix. The value to assign at row 4 column 4 of the matrix.

Initializes a new instance of the struct.

The values to assign to the components of the matrix. This must be an array with sixteen elements. Thrown when is null. Thrown when contains more or less than sixteen elements.

Gets or sets the first row in the matrix; that is M11, M12, M13, and M14.

Gets or sets the second row in the matrix; that is M21, M22, M23, and M24.

Gets or sets the third row in the matrix; that is M31, M32, M33, and M34.

Gets or sets the fourth row in the matrix; that is M41, M42, M43, and M44.

Gets or sets the first column in the matrix; that is M11, M21, M31, and M41.

Gets or sets the second column in the matrix; that is M12, M22, M32, and M42.

Gets or sets the third column in the matrix; that is M13, M23, M33, and M43.

Gets or sets the fourth column in the matrix; that is M14, M24, M34, and M44.

Gets or sets the translation of the matrix; that is M41, M42, and M43.

Gets or sets the scale of the matrix; that is M11, M22, and M33.

Gets a value indicating whether this instance is an identity matrix.

true if this instance is an identity matrix; otherwise, false.

Gets or sets the component at the specified index.

The value of the matrix component, depending on the index. The zero-based index of the component to access. The value of the component at the specified index. Thrown when the is out of the range [0, 15].

Gets or sets the component at the specified index.

The value of the matrix component, depending on the index. The row of the matrix to access. The column of the matrix to access. The value of the component at the specified index. Thrown when the or is out of the range [0, 3].

Calculates the determinant of the matrix.

The determinant of the matrix.

Inverts the matrix.

Transposes the matrix.

Orthogonalizes the specified matrix.

Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the matrix will be orthogonal to any other given row in the matrix. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthonormalizes the specified matrix.

Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Decomposes a matrix into an orthonormalized matrix Q and a right triangular matrix R.

When the method completes, contains the orthonormalized matrix of the decomposition. When the method completes, contains the right triangular matrix of the decomposition.

Decomposes a matrix into a lower triangular matrix L and an orthonormalized matrix Q.

When the method completes, contains the lower triangular matrix of the decomposition. When the method completes, contains the orthonormalized matrix of the decomposition.

Decomposes a matrix into a scale, rotation, and translation.

When the method completes, contains the scaling component of the decomposed matrix. When the method completes, contains the rotation component of the decomposed matrix. When the method completes, contains the translation component of the decomposed matrix. This method is designed to decompose an SRT transformation matrix only.

Decomposes a uniform scale matrix into a scale, rotation, and translation. A uniform scale matrix has the same scale in every axis.

Exchanges two rows in the matrix.

The first row to exchange. This is an index of the row starting at zero. The second row to exchange. This is an index of the row starting at zero.

Exchanges two columns in the matrix.

The first column to exchange. This is an index of the column starting at zero. The second column to exchange. This is an index of the column starting at zero.

Creates an array containing the elements of the matrix.

A sixteen-element array containing the components of the matrix.

Determines the sum of two matrices.

The first matrix to add. The second matrix to add. When the method completes, contains the sum of the two matrices.

Determines the sum of two matrices.

The first matrix to add. The second matrix to add. The sum of the two matrices.

Determines the difference between two matrices.

The first matrix to subtract. The second matrix to subtract. When the method completes, contains the difference between the two matrices.

Determines the difference between two matrices.

The first matrix to subtract. The second matrix to subtract. The difference between the two matrices.

Scales a matrix by the given value.

The matrix to scale. The amount by which to scale. When the method completes, contains the scaled matrix.

Scales a matrix by the given value.

The matrix to scale. The amount by which to scale. The scaled matrix.

Determines the product of two matrices.

The first matrix to multiply. The second matrix to multiply. The product of the two matrices.

Determines the product of two matrices.

The first matrix to multiply. The second matrix to multiply. The product of the two matrices.

Scales a matrix by the given value.

The matrix to scale. The amount by which to scale. When the method completes, contains the scaled matrix.

Scales a matrix by the given value.

The matrix to scale. The amount by which to scale. The scaled matrix.

Determines the quotient of two matrices.

The first matrix to divide. The second matrix to divide. When the method completes, contains the quotient of the two matrices.

Determines the quotient of two matrices.

The first matrix to divide. The second matrix to divide. The quotient of the two matrices.

Performs the exponential operation on a matrix.

The matrix to perform the operation on. The exponent to raise the matrix to. When the method completes, contains the exponential matrix. Thrown when the is negative.

Performs the exponential operation on a matrix.

The matrix to perform the operation on. The exponent to raise the matrix to. The exponential matrix. Thrown when the is negative.

Negates a matrix.

The matrix to be negated. When the method completes, contains the negated matrix.

Negates a matrix.

The matrix to be negated. The negated matrix.

Performs a linear interpolation between two matrices.

Start matrix. End matrix. Value between 0 and 1 indicating the weight of . When the method completes, contains the linear interpolation of the two matrices. Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Performs a linear interpolation between two matrices.

Start matrix. End matrix. Value between 0 and 1 indicating the weight of . The linear interpolation of the two matrices. Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Performs a cubic interpolation between two matrices.

Start matrix. End matrix. Value between 0 and 1 indicating the weight of . When the method completes, contains the cubic interpolation of the two matrices.

Performs a cubic interpolation between two matrices.

Start matrix. End matrix. Value between 0 and 1 indicating the weight of . The cubic interpolation of the two matrices.

Calculates the transpose of the specified matrix.

The matrix whose transpose is to be calculated. When the method completes, contains the transpose of the specified matrix.

Calculates the transpose of the specified matrix.

The matrix whose transpose is to be calculated. When the method completes, contains the transpose of the specified matrix.

Calculates the transpose of the specified matrix.

The matrix whose transpose is to be calculated. The transpose of the specified matrix.

Calculates the inverse of the specified matrix.

The matrix whose inverse is to be calculated. When the method completes, contains the inverse of the specified matrix.

Calculates the inverse of the specified matrix.

The matrix whose inverse is to be calculated. The inverse of the specified matrix.

Orthogonalizes the specified matrix.

The matrix to orthogonalize. When the method completes, contains the orthogonalized matrix. Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the matrix will be orthogonal to any other given row in the matrix. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthogonalizes the specified matrix.

The matrix to orthogonalize. The orthogonalized matrix. Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the matrix will be orthogonal to any other given row in the matrix. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthonormalizes the specified matrix.

The matrix to orthonormalize. When the method completes, contains the orthonormalized matrix. Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthonormalizes the specified matrix.

The matrix to orthonormalize. The orthonormalized matrix. Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting matrix tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the matrix rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Brings the matrix into upper triangular form using elementary row operations.

The matrix to put into upper triangular form. When the method completes, contains the upper triangular matrix. If the matrix is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the matrix into upper triangular form using elementary row operations.

The matrix to put into upper triangular form. The upper triangular matrix. If the matrix is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the matrix into lower triangular form using elementary row operations.

The matrix to put into lower triangular form. When the method completes, contains the lower triangular matrix. If the matrix is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the matrix into lower triangular form using elementary row operations.

The matrix to put into lower triangular form. The lower triangular matrix. If the matrix is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the matrix represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the matrix into row echelon form using elementary row operations;

The matrix to put into row echelon form. When the method completes, contains the row echelon form of the matrix.

Brings the matrix into row echelon form using elementary row operations;

The matrix to put into row echelon form. When the method completes, contains the row echelon form of the matrix.

Brings the matrix into reduced row echelon form using elementary row operations.

The matrix to put into reduced row echelon form. The fifth column of the matrix. When the method completes, contains the resultant matrix after the operation. When the method completes, contains the resultant fifth column of the matrix. The fifth column is often called the augmented part of the matrix. This is because the fifth column is really just an extension of the matrix so that there is a place to put all of the non-zero components after the operation is complete. Often times the resultant matrix will the identity matrix or a matrix similar to the identity matrix. Sometimes, however, that is not possible and numbers other than zero and one may appear. This method can be used to solve systems of linear equations. Upon completion of this method, the will contain the solution for the system. It is up to the user to analyze both the input and the result to determine if a solution really exists.

Creates a left-handed spherical billboard that rotates around a specified object position.

The position of the object around which the billboard will rotate. The position of the camera. The up vector of the camera. The forward vector of the camera. When the method completes, contains the created billboard matrix.

Creates a left-handed spherical billboard that rotates around a specified object position.

The position of the object around which the billboard will rotate. The position of the camera. The up vector of the camera. The forward vector of the camera. The created billboard matrix.

Creates a right-handed spherical billboard that rotates around a specified object position.

The position of the object around which the billboard will rotate. The position of the camera. The up vector of the camera. The forward vector of the camera. The created billboard matrix.

Creates a left-handed, look-at matrix.

The position of the viewer's eye. The camera look-at target. The camera's up vector. When the method completes, contains the created look-at matrix.

Creates a left-handed, look-at matrix.

The position of the viewer's eye. The camera look-at target. The camera's up vector. The created look-at matrix.

Creates a right-handed, look-at matrix.

The position of the viewer's eye. The camera look-at target. The camera's up vector. When the method completes, contains the created look-at matrix.

Creates a right-handed, look-at matrix.

The position of the viewer's eye. The camera look-at target. The camera's up vector. The created look-at matrix.

Creates a left-handed, orthographic projection matrix.

Width of the viewing volume. Height of the viewing volume. Minimum z-value of the viewing volume. Maximum z-value of the viewing volume. When the method completes, contains the created projection matrix.

Creates a left-handed, orthographic projection matrix.

Width of the viewing volume. Height of the viewing volume. Minimum z-value of the viewing volume. Maximum z-value of the viewing volume. The created projection matrix.

Creates a right-handed, orthographic projection matrix.

Width of the viewing volume. Height of the viewing volume. Minimum z-value of the viewing volume. Maximum z-value of the viewing volume. The created projection matrix.

Creates a left-handed, customized orthographic projection matrix.

Minimum x-value of the viewing volume. Maximum x-value of the viewing volume. Minimum y-value of the viewing volume. Maximum y-value of the viewing volume. Minimum z-value of the viewing volume. Maximum z-value of the viewing volume. When the method completes, contains the created projection matrix.

Creates a left-handed, customized orthographic projection matrix.

Creates a right-handed, customized orthographic projection matrix.

Creates a left-handed, perspective projection matrix.

Width of the viewing volume. Height of the viewing volume. Minimum z-value of the viewing volume. Maximum z-value of the viewing volume. The created projection matrix.

Creates a right-handed, perspective projection matrix.

Width of the viewing volume. Height of the viewing volume. Minimum z-value of the viewing volume. Maximum z-value of the viewing volume. The created projection matrix.

Creates a left-handed, perspective projection matrix based on a field of view.

Field of view in the y direction, in radians. Aspect ratio, defined as view space width divided by height. Minimum z-value of the viewing volume. Maximum z-value of the viewing volume. When the method completes, contains the created projection matrix.

Creates a left-handed, perspective projection matrix based on a field of view.

Creates a right-handed, perspective projection matrix based on a field of view.

Creates a left-handed, customized perspective projection matrix.

Creates a right-handed, customized perspective projection matrix.

Creates a matrix that scales along the x-axis, y-axis, and y-axis.

Scaling factor for all three axes. When the method completes, contains the created scaling matrix.

Creates a matrix that scales along the x-axis, y-axis, and y-axis.

Scaling factor for all three axes. The created scaling matrix.

Creates a matrix that scales along the x-axis, y-axis, and y-axis.

Scaling factor that is applied along the x-axis. Scaling factor that is applied along the y-axis. Scaling factor that is applied along the z-axis. When the method completes, contains the created scaling matrix.

Creates a matrix that scales along the x-axis, y-axis, and y-axis.

Scaling factor that is applied along the x-axis. Scaling factor that is applied along the y-axis. Scaling factor that is applied along the z-axis. The created scaling matrix.

Creates a matrix that uniformly scales along all three axis.

The uniform scale that is applied along all axis. When the method completes, contains the created scaling matrix.

Creates a matrix that uniformly scales along all three axis.

The uniform scale that is applied along all axis. The created scaling matrix.

Creates a matrix that rotates around the x-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. When the method completes, contains the created rotation matrix.

Creates a matrix that rotates around the x-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. The created rotation matrix.

Creates a matrix that rotates around the y-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. When the method completes, contains the created rotation matrix.

Creates a matrix that rotates around the y-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. The created rotation matrix.

Creates a matrix that rotates around the z-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. When the method completes, contains the created rotation matrix.

Creates a matrix that rotates around the z-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. The created rotation matrix.

Creates a matrix that rotates around an arbitrary axis.

The axis around which to rotate. This parameter is assumed to be normalized. Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. When the method completes, contains the created rotation matrix.

Creates a matrix that rotates around an arbitrary axis.

Creates a rotation matrix from a quaternion.

The quaternion to use to build the matrix. The created rotation matrix.

Creates a rotation matrix from a quaternion.

The quaternion to use to build the matrix. The created rotation matrix.

Creates a rotation matrix with a specified yaw, pitch, and roll.

Yaw around the y-axis, in radians. Pitch around the x-axis, in radians. Roll around the z-axis, in radians. When the method completes, contains the created rotation matrix.

Creates a rotation matrix with a specified yaw, pitch, and roll.

Yaw around the y-axis, in radians. Pitch around the x-axis, in radians. Roll around the z-axis, in radians. The created rotation matrix.

Creates a translation matrix using the specified offsets.

The offset for all three coordinate planes. When the method completes, contains the created translation matrix.

Creates a translation matrix using the specified offsets.

The offset for all three coordinate planes. The created translation matrix.

Creates a translation matrix using the specified offsets.

X-coordinate offset. Y-coordinate offset. Z-coordinate offset. When the method completes, contains the created translation matrix.

Creates a translation matrix using the specified offsets.

X-coordinate offset. Y-coordinate offset. Z-coordinate offset. The created translation matrix.

Creates a skew/shear matrix by means of a translation vector, a rotation vector, and a rotation angle. shearing is performed in the direction of translation vector, where translation vector and rotation vector define the shearing plane. The effect is such that the skewed rotation vector has the specified angle with rotation itself.

The rotation angle. The rotation vector The translation vector Contains the created skew/shear matrix.

Creates a 3D affine transformation matrix.

Scaling factor. The rotation of the transformation. The translation factor of the transformation. When the method completes, contains the created affine transformation matrix.

Creates a 3D affine transformation matrix.

Scaling factor. The rotation of the transformation. The translation factor of the transformation. The created affine transformation matrix.

Creates a 3D affine transformation matrix.

Scaling factor. The center of the rotation. The rotation of the transformation. The translation factor of the transformation. When the method completes, contains the created affine transformation matrix.

Creates a 3D affine transformation matrix.

Scaling factor. The center of the rotation. The rotation of the transformation. The translation factor of the transformation. The created affine transformation matrix.

Creates a 2D affine transformation matrix.

Scaling factor. The rotation of the transformation. The translation factor of the transformation. When the method completes, contains the created affine transformation matrix.

Creates a 2D affine transformation matrix.

Scaling factor. The rotation of the transformation. The translation factor of the transformation. The created affine transformation matrix.

Creates a 2D affine transformation matrix.

Scaling factor. The center of the rotation. The rotation of the transformation. The translation factor of the transformation. The created affine transformation matrix.

Creates a transformation matrix.

Center point of the scaling operation. Scaling rotation amount. Scaling factor. The center of the rotation. The rotation of the transformation. The translation factor of the transformation. When the method completes, contains the created transformation matrix.

Creates a transformation matrix.

Creates a 2D transformation matrix.

Adds two matrices.

The first matrix to add. The second matrix to add. The sum of the two matrices.

Assert a matrix (return it unchanged).

The matrix to assert (unchanged). The asserted (unchanged) matrix.

Subtracts two matrices.

The first matrix to subtract. The second matrix to subtract. The difference between the two matrices.

Negates a matrix.

The matrix to negate. The negated matrix.

Scales a matrix by a given value.

The matrix to scale. The amount by which to scale. The scaled matrix.

Scales a matrix by a given value.

The matrix to scale. The amount by which to scale. The scaled matrix.

Multiplies two matrices.

The first matrix to multiply. The second matrix to multiply. The product of the two matrices.

Scales a matrix by a given value.

The matrix to scale. The amount by which to scale. The scaled matrix.

Divides two matrices.

The first matrix to divide. The second matrix to divide. The quotient of the two matrices.

Tests for equality between two objects.

The first value to compare. The second value to compare. true if has the same value as ; otherwise, false.

Tests for inequality between two objects.

The first value to compare. The second value to compare. true if has a different value than ; otherwise, false.

Returns a that represents this instance.

A that represents this instance.

Returns a that represents this instance.

The format. A that represents this instance.

Returns a that represents this instance.

The format provider. A that represents this instance.

Returns a that represents this instance.

The format. The format provider. A that represents this instance.

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Represents a 3x3 Matrix ( contains only Scale and Rotation ).

A with all of its components set to zero.

The identity .

Value at row 1 column 1 of the Matrix3x3.

Value at row 1 column 2 of the Matrix3x3.

Value at row 1 column 3 of the Matrix3x3.

Value at row 2 column 1 of the Matrix3x3.

Value at row 2 column 2 of the Matrix3x3.

Value at row 2 column 3 of the Matrix3x3.

Value at row 3 column 1 of the Matrix3x3.

Value at row 3 column 2 of the Matrix3x3.

Value at row 3 column 3 of the Matrix3x3.

Initializes a new instance of the struct.

The value that will be assigned to all components.

Initializes a new instance of the struct.

The value to assign at row 1 column 1 of the Matrix3x3. The value to assign at row 1 column 2 of the Matrix3x3. The value to assign at row 1 column 3 of the Matrix3x3. The value to assign at row 2 column 1 of the Matrix3x3. The value to assign at row 2 column 2 of the Matrix3x3. The value to assign at row 2 column 3 of the Matrix3x3. The value to assign at row 3 column 1 of the Matrix3x3. The value to assign at row 3 column 2 of the Matrix3x3. The value to assign at row 3 column 3 of the Matrix3x3.

Initializes a new instance of the struct.

The values to assign to the components of the Matrix3x3. This must be an array with sixteen elements. Thrown when is null. Thrown when contains more or less than sixteen elements.

Gets or sets the first row in the Matrix3x3; that is M11, M12, M13

Gets or sets the second row in the Matrix3x3; that is M21, M22, M23

Gets or sets the third row in the Matrix3x3; that is M31, M32, M33

Gets or sets the first column in the Matrix3x3; that is M11, M21, M31

Gets or sets the second column in the Matrix3x3; that is M12, M22, M32

Gets or sets the third column in the Matrix3x3; that is M13, M23, M33

Gets or sets the scale of the Matrix3x3; that is M11, M22, and M33.

Gets a value indicating whether this instance is an identity Matrix3x3.

true if this instance is an identity Matrix3x3; otherwise, false.

Gets or sets the component at the specified index.

The value of the Matrix3x3 component, depending on the index. The zero-based index of the component to access. The value of the component at the specified index. Thrown when the is out of the range [0, 15].

Gets or sets the component at the specified index.

The value of the Matrix3x3 component, depending on the index. The row of the Matrix3x3 to access. The column of the Matrix3x3 to access. The value of the component at the specified index. Thrown when the or is out of the range [0, 3].

Calculates the determinant of the Matrix3x3.

The determinant of the Matrix3x3.

Inverts the Matrix3x3.

Transposes the Matrix3x3.

Orthogonalizes the specified Matrix3x3.

Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the Matrix3x3 will be orthogonal to any other given row in the Matrix3x3. Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3 tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the Matrix3x3 rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthonormalizes the specified Matrix3x3.

Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3 tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the Matrix3x3 rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Decomposes a Matrix3x3 into an orthonormalized Matrix3x3 Q and a right triangular Matrix3x3 R.

When the method completes, contains the orthonormalized Matrix3x3 of the decomposition. When the method completes, contains the right triangular Matrix3x3 of the decomposition.

Decomposes a Matrix3x3 into a lower triangular Matrix3x3 L and an orthonormalized Matrix3x3 Q.

When the method completes, contains the lower triangular Matrix3x3 of the decomposition. When the method completes, contains the orthonormalized Matrix3x3 of the decomposition.

Decomposes a Matrix3x3 into a scale, rotation, and translation.

When the method completes, contains the scaling component of the decomposed Matrix3x3. When the method completes, contains the rotation component of the decomposed Matrix3x3. This method is designed to decompose an SRT transformation Matrix3x3 only.

Decomposes a uniform scale matrix into a scale, rotation, and translation. A uniform scale matrix has the same scale in every axis.

When the method completes, contains the scaling component of the decomposed matrix. When the method completes, contains the rotation component of the decomposed matrix. This method is designed to decompose only an SRT transformation matrix that has the same scale in every axis.

Exchanges two rows in the Matrix3x3.

The first row to exchange. This is an index of the row starting at zero. The second row to exchange. This is an index of the row starting at zero.

Exchanges two columns in the Matrix3x3.

The first column to exchange. This is an index of the column starting at zero. The second column to exchange. This is an index of the column starting at zero.

Creates an array containing the elements of the Matrix3x3.

A 9-element array containing the components of the Matrix3x3.

Determines the sum of two matrices.

The first Matrix3x3 to add. The second Matrix3x3 to add. When the method completes, contains the sum of the two matrices.

Determines the sum of two matrices.

The first Matrix3x3 to add. The second Matrix3x3 to add. The sum of the two matrices.

Determines the difference between two matrices.

The first Matrix3x3 to subtract. The second Matrix3x3 to subtract. When the method completes, contains the difference between the two matrices.

Determines the difference between two matrices.

The first Matrix3x3 to subtract. The second Matrix3x3 to subtract. The difference between the two matrices.

Scales a Matrix3x3 by the given value.

The Matrix3x3 to scale. The amount by which to scale. When the method completes, contains the scaled Matrix3x3.

Scales a Matrix3x3 by the given value.

The Matrix3x3 to scale. The amount by which to scale. The scaled Matrix3x3.

Determines the product of two matrices.

The first Matrix3x3 to multiply. The second Matrix3x3 to multiply. The product of the two matrices.

Determines the product of two matrices.

The first Matrix3x3 to multiply. The second Matrix3x3 to multiply. The product of the two matrices.

Scales a Matrix3x3 by the given value.

The Matrix3x3 to scale. The amount by which to scale. When the method completes, contains the scaled Matrix3x3.

Scales a Matrix3x3 by the given value.

The Matrix3x3 to scale. The amount by which to scale. The scaled Matrix3x3.

Determines the quotient of two matrices.

The first Matrix3x3 to divide. The second Matrix3x3 to divide. When the method completes, contains the quotient of the two matrices.

Determines the quotient of two matrices.

The first Matrix3x3 to divide. The second Matrix3x3 to divide. The quotient of the two matrices.

Performs the exponential operation on a Matrix3x3.

The Matrix3x3 to perform the operation on. The exponent to raise the Matrix3x3 to. When the method completes, contains the exponential Matrix3x3. Thrown when the is negative.

Performs the exponential operation on a Matrix3x3.

The Matrix3x3 to perform the operation on. The exponent to raise the Matrix3x3 to. The exponential Matrix3x3. Thrown when the is negative.

Negates a Matrix3x3.

The Matrix3x3 to be negated. When the method completes, contains the negated Matrix3x3.

Negates a Matrix3x3.

The Matrix3x3 to be negated. The negated Matrix3x3.

Performs a linear interpolation between two matrices.

Start Matrix3x3. End Matrix3x3. Value between 0 and 1 indicating the weight of . When the method completes, contains the linear interpolation of the two matrices. Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Performs a linear interpolation between two matrices.

Start Matrix3x3. End Matrix3x3. Value between 0 and 1 indicating the weight of . The linear interpolation of the two matrices. Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Performs a cubic interpolation between two matrices.

Start Matrix3x3. End Matrix3x3. Value between 0 and 1 indicating the weight of . When the method completes, contains the cubic interpolation of the two matrices.

Performs a cubic interpolation between two matrices.

Start Matrix3x3. End Matrix3x3. Value between 0 and 1 indicating the weight of . The cubic interpolation of the two matrices.

Calculates the transpose of the specified Matrix3x3.

The Matrix3x3 whose transpose is to be calculated. When the method completes, contains the transpose of the specified Matrix3x3.

Calculates the transpose of the specified Matrix3x3.

The Matrix3x3 whose transpose is to be calculated. When the method completes, contains the transpose of the specified Matrix3x3.

Calculates the transpose of the specified Matrix3x3.

The Matrix3x3 whose transpose is to be calculated. The transpose of the specified Matrix3x3.

Calculates the inverse of the specified Matrix3x3.

The Matrix3x3 whose inverse is to be calculated. When the method completes, contains the inverse of the specified Matrix3x3.

Calculates the inverse of the specified Matrix3x3.

The Matrix3x3 whose inverse is to be calculated. The inverse of the specified Matrix3x3.

Orthogonalizes the specified Matrix3x3.

The Matrix3x3 to orthogonalize. When the method completes, contains the orthogonalized Matrix3x3. Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the Matrix3x3 will be orthogonal to any other given row in the Matrix3x3. Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3 tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the Matrix3x3 rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthogonalizes the specified Matrix3x3.

The Matrix3x3 to orthogonalize. The orthogonalized Matrix3x3. Orthogonalization is the process of making all rows orthogonal to each other. This means that any given row in the Matrix3x3 will be orthogonal to any other given row in the Matrix3x3. Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3 tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the Matrix3x3 rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthonormalizes the specified Matrix3x3.

The Matrix3x3 to orthonormalize. When the method completes, contains the orthonormalized Matrix3x3. Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3 tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the Matrix3x3 rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Orthonormalizes the specified Matrix3x3.

The Matrix3x3 to orthonormalize. The orthonormalized Matrix3x3. Orthonormalization is the process of making all rows and columns orthogonal to each other and making all rows and columns of unit length. This means that any given row will be orthogonal to any other given row and any given column will be orthogonal to any other given column. Any given row will not be orthogonal to any given column. Every row and every column will be of unit length. Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3 tends to be numerically unstable. The numeric stability decreases according to the rows so that the first row is the most stable and the last row is the least stable. This operation is performed on the rows of the Matrix3x3 rather than the columns. If you wish for this operation to be performed on the columns, first transpose the input and than transpose the output.

Brings the Matrix3x3 into upper triangular form using elementary row operations.

The Matrix3x3 to put into upper triangular form. When the method completes, contains the upper triangular Matrix3x3. If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the Matrix3x3 into upper triangular form using elementary row operations.

The Matrix3x3 to put into upper triangular form. The upper triangular Matrix3x3. If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the Matrix3x3 into lower triangular form using elementary row operations.

The Matrix3x3 to put into lower triangular form. When the method completes, contains the lower triangular Matrix3x3. If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the Matrix3x3 into lower triangular form using elementary row operations.

The Matrix3x3 to put into lower triangular form. The lower triangular Matrix3x3. If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system of linear equations, than this often means that either no solution exists or an infinite number of solutions exist.

Brings the Matrix3x3 into row echelon form using elementary row operations;

The Matrix3x3 to put into row echelon form. When the method completes, contains the row echelon form of the Matrix3x3.

Brings the Matrix3x3 into row echelon form using elementary row operations;

The Matrix3x3 to put into row echelon form. When the method completes, contains the row echelon form of the Matrix3x3.

Creates a left-handed spherical billboard that rotates around a specified object position.

The position of the object around which the billboard will rotate. The position of the camera. The up vector of the camera. The forward vector of the camera. The created billboard Matrix3x3.

Creates a right-handed spherical billboard that rotates around a specified object position.

The position of the object around which the billboard will rotate. The position of the camera. The up vector of the camera. The forward vector of the camera. The created billboard Matrix3x3.

Creates a left-handed, look-at Matrix3x3.

The position of the viewer's eye. The camera look-at target. The camera's up vector. When the method completes, contains the created look-at Matrix3x3.

Creates a left-handed, look-at Matrix3x3.

The position of the viewer's eye. The camera look-at target. The camera's up vector. The created look-at Matrix3x3.

Creates a right-handed, look-at Matrix3x3.

The position of the viewer's eye. The camera look-at target. The camera's up vector. When the method completes, contains the created look-at Matrix3x3.

Creates a right-handed, look-at Matrix3x3.

The position of the viewer's eye. The camera look-at target. The camera's up vector. The created look-at Matrix3x3.

Creates a Matrix3x3 that scales along the x-axis, y-axis, and y-axis.

Scaling factor for all three axes. When the method completes, contains the created scaling Matrix3x3.

Creates a Matrix3x3 that scales along the x-axis, y-axis, and y-axis.

Scaling factor for all three axes. The created scaling Matrix3x3.

Creates a Matrix3x3 that scales along the x-axis, y-axis, and y-axis.

Scaling factor that is applied along the x-axis. Scaling factor that is applied along the y-axis. Scaling factor that is applied along the z-axis. The created scaling Matrix3x3.

Creates a Matrix3x3 that uniformly scales along all three axis.

The uniform scale that is applied along all axis. When the method completes, contains the created scaling Matrix3x3.

Creates a Matrix3x3 that uniformly scales along all three axis.

The uniform scale that is applied along all axis. The created scaling Matrix3x3.

Creates a Matrix3x3 that rotates around the x-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. When the method completes, contains the created rotation Matrix3x3.

Creates a Matrix3x3 that rotates around the x-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. The created rotation Matrix3x3.

Creates a Matrix3x3 that rotates around the y-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. When the method completes, contains the created rotation Matrix3x3.

Creates a Matrix3x3 that rotates around the y-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. The created rotation Matrix3x3.

Creates a Matrix3x3 that rotates around the z-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. When the method completes, contains the created rotation Matrix3x3.

Creates a Matrix3x3 that rotates around the z-axis.

Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin. The created rotation Matrix3x3.

Creates a Matrix3x3 that rotates around an arbitrary axis.

Creates a rotation Matrix3x3 from a quaternion.

The quaternion to use to build the Matrix3x3. The created rotation Matrix3x3.

Creates a rotation Matrix3x3 from a quaternion.

The quaternion to use to build the Matrix3x3. The created rotation Matrix3x3.

Creates a rotation Matrix3x3 with a specified yaw, pitch, and roll.

Yaw around the y-axis, in radians. Pitch around the x-axis, in radians. Roll around the z-axis, in radians. When the method completes, contains the created rotation Matrix3x3.

Creates a rotation Matrix3x3 with a specified yaw, pitch, and roll.

Yaw around the y-axis, in radians. Pitch around the x-axis, in radians. Roll around the z-axis, in radians. The created rotation Matrix3x3.

Adds two matrices.

The first Matrix3x3 to add. The second Matrix3x3 to add. The sum of the two matrices.

Assert a Matrix3x3 (return it unchanged).

The Matrix3x3 to assert (unchanged). The asserted (unchanged) Matrix3x3.

Subtracts two matrices.

The first Matrix3x3 to subtract. The second Matrix3x3 to subtract. The difference between the two matrices.

Negates a Matrix3x3.

The Matrix3x3 to negate. The negated Matrix3x3.

Scales a Matrix3x3 by a given value.

The Matrix3x3 to scale. The amount by which to scale. The scaled Matrix3x3.

Scales a Matrix3x3 by a given value.

The Matrix3x3 to scale. The amount by which to scale. The scaled Matrix3x3.

Multiplies two matrices.

The first Matrix3x3 to multiply. The second Matrix3x3 to multiply. The product of the two matrices.

Scales a Matrix3x3 by a given value.

The Matrix3x3 to scale. The amount by which to scale. The scaled Matrix3x3.

Divides two matrices.

The first Matrix3x3 to divide. The second Matrix3x3 to divide. The quotient of the two matrices.

Tests for equality between two objects.

The first value to compare. The second value to compare. true if has the same value as ; otherwise, false.

Tests for inequality between two objects.

The first value to compare. The second value to compare. true if has a different value than ; otherwise, false.

Convert the 3x3 Matrix to a 4x4 Matrix.

A 4x4 Matrix with zero translation and M44=1

Convert the 4x4 Matrix to a 3x3 Matrix.

A 3x3 Matrix

Returns a that represents this instance.

A that represents this instance.

Returns a that represents this instance.

The format. A that represents this instance.

Returns a that represents this instance.

The format provider. A that represents this instance.

Returns a that represents this instance.

The format. The format provider. A that represents this instance.

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified are equal.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Represents a four dimensional mathematical quaternion.

A with all of its components set to zero.

A with all of its components set to one.

The identity (0, 0, 0, 1).

The X component of the quaternion.

The Y component of the quaternion.

The Z component of the quaternion.

The W component of the quaternion.

Initializes a new instance of the struct.

The value that will be assigned to all components.

Initializes a new instance of the struct.

A vector containing the values with which to initialize the components.

Initializes a new instance of the struct.

A vector containing the values with which to initialize the X, Y, and Z components. Initial value for the W component of the quaternion.

Initializes a new instance of the struct.

A vector containing the values with which to initialize the X and Y components. Initial value for the Z component of the quaternion. Initial value for the W component of the quaternion.

Initializes a new instance of the struct.

Initial value for the X component of the quaternion. Initial value for the Y component of the quaternion. Initial value for the Z component of the quaternion. Initial value for the W component of the quaternion.

Initializes a new instance of the struct.

The values to assign to the X, Y, Z, and W components of the quaternion. This must be an array with four elements. Thrown when is null. Thrown when contains more or less than four elements.

Gets a value indicating whether this instance is equivalent to the identity quaternion.

true if this instance is an identity quaternion; otherwise, false.

Gets a value indicting whether this instance is normalized.

Gets the angle of the quaternion.

The quaternion's angle.

Gets the axis components of the quaternion.

The axis components of the quaternion.

Gets or sets the component at the specified index.

The value of the X, Y, Z, or W component, depending on the index. The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. The value of the component at the specified index. Thrown when the is out of the range [0, 3].

Conjugates the quaternion.

Conjugates and renormalizes the quaternion.

Calculates the length of the quaternion.

The length of the quaternion. may be preferred when only the relative length is needed and speed is of the essence.

Calculates the squared length of the quaternion.

The squared length of the quaternion. This method may be preferred to when only a relative length is needed and speed is of the essence.

Converts the quaternion into a unit quaternion.

Creates an array containing the elements of the quaternion.

A four-element array containing the components of the quaternion.

Adds two quaternions.

The first quaternion to add. The second quaternion to add. When the method completes, contains the sum of the two quaternions.

Adds two quaternions.

The first quaternion to add. The second quaternion to add. The sum of the two quaternions.

Subtracts two quaternions.

The first quaternion to subtract. The second quaternion to subtract. When the method completes, contains the difference of the two quaternions.

Subtracts two quaternions.

The first quaternion to subtract. The second quaternion to subtract. The difference of the two quaternions.

Scales a quaternion by the given value.

The quaternion to scale. The amount by which to scale the quaternion. When the method completes, contains the scaled quaternion.

Scales a quaternion by the given value.

The quaternion to scale. The amount by which to scale the quaternion. The scaled quaternion.

Multiplies a quaternion by another.

The first quaternion to multiply. The second quaternion to multiply. When the method completes, contains the multiplied quaternion.

Multiplies a quaternion by another.

The first quaternion to multiply. The second quaternion to multiply. The multiplied quaternion.

Reverses the direction of a given quaternion.

The quaternion to negate. When the method completes, contains a quaternion facing in the opposite direction.

Reverses the direction of a given quaternion.

The quaternion to negate. A quaternion facing in the opposite direction.

Returns a containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.

A containing the 4D Cartesian coordinates of vertex 1 of the triangle. A containing the 4D Cartesian coordinates of vertex 2 of the triangle. A containing the 4D Cartesian coordinates of vertex 3 of the triangle. Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). When the method completes, contains a new containing the 4D Cartesian coordinates of the specified point.

Returns a containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.

A containing the 4D Cartesian coordinates of vertex 1 of the triangle. A containing the 4D Cartesian coordinates of vertex 2 of the triangle. A containing the 4D Cartesian coordinates of vertex 3 of the triangle. Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). A new containing the 4D Cartesian coordinates of the specified point.

Conjugates a quaternion.

The quaternion to conjugate. When the method completes, contains the conjugated quaternion.

Conjugates a quaternion.

The quaternion to conjugate. The conjugated quaternion.

Calculates the dot product of two quaternions.

First source quaternion. Second source quaternion. When the method completes, contains the dot product of the two quaternions.

Calculates the dot product of two quaternions.

First source quaternion. Second source quaternion. The dot product of the two quaternions.

Exponentiates a quaternion.

The quaternion to exponentiate. When the method completes, contains the exponentiated quaternion.

Exponentiates a quaternion.

The quaternion to exponentiate. The exponentiated quaternion.

Conjugates and renormalizes the quaternion.

The quaternion to conjugate and renormalize. When the method completes, contains the conjugated and renormalized quaternion.

Conjugates and renormalizes the quaternion.

The quaternion to conjugate and renormalize. The conjugated and renormalized quaternion.

Performs a linear interpolation between two quaternions.

Start quaternion. End quaternion. Value between 0 and 1 indicating the weight of . When the method completes, contains the linear interpolation of the two quaternions. This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Performs a linear interpolation between two quaternion.

Start quaternion. End quaternion. Value between 0 and 1 indicating the weight of . The linear interpolation of the two quaternions. This method performs the linear interpolation based on the following formula. start + (end - start) * amount Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Calculates the natural logarithm of the specified quaternion.

The quaternion whose logarithm will be calculated. When the method completes, contains the natural logarithm of the quaternion.

Calculates the natural logarithm of the specified quaternion.

The quaternion whose logarithm will be calculated. The natural logarithm of the quaternion.

Converts the quaternion into a unit quaternion.

The quaternion to normalize. When the method completes, contains the normalized quaternion.

Converts the quaternion into a unit quaternion.

The quaternion to normalize. The normalized quaternion.

Creates a quaternion given a rotation and an axis.

The axis of rotation. The angle of rotation. When the method completes, contains the newly created quaternion.

Creates a quaternion given a rotation and an axis.

The axis of rotation. The angle of rotation. The newly created quaternion.

Creates a quaternion given a rotation matrix.

The rotation matrix. When the method completes, contains the newly created quaternion.

Creates a quaternion given a rotation matrix.

The rotation matrix. When the method completes, contains the newly created quaternion.

Creates a left-handed, look-at quaternion.

The position of the viewer's eye. The camera look-at target. The camera's up vector. When the method completes, contains the created look-at quaternion.

Creates a left-handed, look-at quaternion.

The position of the viewer's eye. The camera look-at target. The camera's up vector. The created look-at quaternion.

Creates a left-handed, look-at quaternion.

The camera's forward direction. The camera's up vector. When the method completes, contains the created look-at quaternion.

Creates a left-handed, look-at quaternion.

The camera's forward direction. The camera's up vector. The created look-at quaternion.

Creates a right-handed, look-at quaternion.

The position of the viewer's eye. The camera look-at target. The camera's up vector. When the method completes, contains the created look-at quaternion.

Creates a right-handed, look-at quaternion.

The position of the viewer's eye. The camera look-at target. The camera's up vector. The created look-at quaternion.

Creates a right-handed, look-at quaternion.

The camera's forward direction. The camera's up vector. When the method completes, contains the created look-at quaternion.

Creates a right-handed, look-at quaternion.

The camera's forward direction. The camera's up vector. The created look-at quaternion.

Creates a left-handed spherical billboard that rotates around a specified object position.

The position of the object around which the billboard will rotate. The position of the camera. The up vector of the camera. The forward vector of the camera. The created billboard quaternion.

Creates a right-handed spherical billboard that rotates around a specified object position.

The position of the object around which the billboard will rotate. The position of the camera. The up vector of the camera. The forward vector of the camera. The created billboard quaternion.

Creates a quaternion given a rotation matrix.

The rotation matrix. The newly created quaternion.

Creates a quaternion given a yaw, pitch, and roll value.

The yaw of rotation. The pitch of rotation. The roll of rotation. When the method completes, contains the newly created quaternion.

Creates a quaternion given a yaw, pitch, and roll value.

The yaw of rotation. The pitch of rotation. The roll of rotation. The newly created quaternion.

Interpolates between two quaternions, using spherical linear interpolation.

Start quaternion. End quaternion. Value between 0 and 1 indicating the weight of . When the method completes, contains the spherical linear interpolation of the two quaternions.

Interpolates between two quaternions, using spherical linear interpolation.

Start quaternion. End quaternion. Value between 0 and 1 indicating the weight of . The spherical linear interpolation of the two quaternions.

Interpolates between quaternions, using spherical quadrangle interpolation.

First source quaternion. Second source quaternion. Third source quaternion. Fourth source quaternion. Value between 0 and 1 indicating the weight of interpolation. When the method completes, contains the spherical quadrangle interpolation of the quaternions.

Interpolates between quaternions, using spherical quadrangle interpolation.

First source quaternion. Second source quaternion. Third source quaternion. Fourth source quaternion. Value between 0 and 1 indicating the weight of interpolation. The spherical quadrangle interpolation of the quaternions.

Sets up control points for spherical quadrangle interpolation.

First source quaternion. Second source quaternion. Third source quaternion. Fourth source quaternion. An array of three quaternions that represent control points for spherical quadrangle interpolation.

Adds two quaternions.

The first quaternion to add. The second quaternion to add. The sum of the two quaternions.

Subtracts two quaternions.

The first quaternion to subtract. The second quaternion to subtract. The difference of the two quaternions.

Reverses the direction of a given quaternion.

The quaternion to negate. A quaternion facing in the opposite direction.

Scales a quaternion by the given value.

The quaternion to scale. The amount by which to scale the quaternion. The scaled quaternion.

Scales a quaternion by the given value.

The quaternion to scale. The amount by which to scale the quaternion. The scaled quaternion.

Multiplies a quaternion by another.

The first quaternion to multiply. The second quaternion to multiply. The multiplied quaternion.

Tests for equality between two objects.

The first value to compare. The second value to compare. true if has the same value as ; otherwise, false.

Tests for inequality between two objects.

The first value to compare. The second value to compare. true if has a different value than ; otherwise, false.

Returns a that represents this instance.

A that represents this instance.

Returns a that represents this instance.

The format. A that represents this instance.

Returns a that represents this instance.

The format provider. A that represents this instance.

Returns a that represents this instance.

The format. The format provider. A that represents this instance.

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Represents a two dimensional mathematical vector.

A with all of its components set to zero.

The X unit (1, 0).

The Y unit (0, 1).

A with all of its components set to one.

The X component of the vector.

The Y component of the vector.

Copies to a new instance of the struct.

The value that will be assigned to all components.

Initializes a new instance of the struct.

The value that will be assigned to all components.

Initializes a new instance of the struct.

Initial value for the X component of the vector. Initial value for the Y component of the vector.

Initializes a new instance of the struct.

The values to assign to the X and Y components of the vector. This must be an array with two elements. Thrown when is null. Thrown when contains more or less than two elements.

Gets a value indicting whether this instance is normalized.

Gets a value indicting whether this vector is zero

Gets or sets the component at the specified index.

The value of the X or Y component, depending on the index. The index of the component to access. Use 0 for the X component and 1 for the Y component. The value of the component at the specified index. Thrown when the is out of the range [0, 1].

Calculates the length of the vector.

The length of the vector. may be preferred when only the relative length is needed and speed is of the essence.

Calculates the squared length of the vector.

The squared length of the vector. This method may be preferred to when only a relative length is needed and speed is of the essence.

Converts the vector into a unit vector.

Creates an array containing the elements of the vector.

A two-element array containing the components of the vector.

Adds two vectors.

The first vector to add. The second vector to add. When the method completes, contains the sum of the two vectors.

Adds two vectors.

The first vector to add. The second vector to add. The sum of the two vectors.

Perform a component-wise addition

The input vector The scalar value to be added to elements The vector with added scalar for each element.

Perform a component-wise addition

The input vector The scalar value to be added to elements The vector with added scalar for each element.

Subtracts two vectors.

The first vector to subtract. The second vector to subtract. When the method completes, contains the difference of the two vectors.

Subtracts two vectors.

The first vector to subtract. The second vector to subtract. The difference of the two vectors.

Perform a component-wise subtraction

The input vector The scalar value to be subtraced from elements The vector with subtracted scalar for each element.

Perform a component-wise subtraction

The input vector The scalar value to be subtraced from elements The vector with subtracted scalar for each element.

Perform a component-wise subtraction

The scalar value to be subtraced from elements The input vector The vector with subtracted scalar for each element.

Perform a component-wise subtraction

The scalar value to be subtraced from elements The input vector The vector with subtracted scalar for each element.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. When the method completes, contains the scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Multiplies a vector with another by performing component-wise multiplication.

The first vector to multiply. The second vector to multiply. When the method completes, contains the multiplied vector.

Multiplies a vector with another by performing component-wise multiplication.

The first vector to multiply. The second vector to multiply. The multiplied vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. When the method completes, contains the scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Scales a vector by the given value.

The amount by which to scale the vector. The vector to scale. When the method completes, contains the scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Reverses the direction of a given vector.

The vector to negate. When the method completes, contains a vector facing in the opposite direction.

Reverses the direction of a given vector.

The vector to negate. A vector facing in the opposite direction.

Returns a containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.

A containing the 2D Cartesian coordinates of vertex 1 of the triangle. A containing the 2D Cartesian coordinates of vertex 2 of the triangle. A containing the 2D Cartesian coordinates of vertex 3 of the triangle. Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). When the method completes, contains the 2D Cartesian coordinates of the specified point.

Returns a containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.

A containing the 2D Cartesian coordinates of vertex 1 of the triangle. A containing the 2D Cartesian coordinates of vertex 2 of the triangle. A containing the 2D Cartesian coordinates of vertex 3 of the triangle. Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). A new containing the 2D Cartesian coordinates of the specified point.

Restricts a value to be within a specified range.

The value to clamp. The minimum value. The maximum value. When the method completes, contains the clamped value.

Restricts a value to be within a specified range.

The value to clamp. The minimum value. The maximum value. The clamped value.

Saturates this instance in the range [0,1]

Calculates the distance between two vectors.

The first vector. The second vector. When the method completes, contains the distance between the two vectors. may be preferred when only the relative distance is needed and speed is of the essence.

Calculates the distance between two vectors.

The first vector. The second vector. The distance between the two vectors. may be preferred when only the relative distance is needed and speed is of the essence.

Calculates the squared distance between two vectors.

The first vector. The second vector When the method completes, contains the squared distance between the two vectors. Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots.

Calculates the squared distance between two vectors.

The first vector. The second vector. The squared distance between the two vectors. Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots.

Calculates the dot product of two vectors.

First source vector. Second source vector. When the method completes, contains the dot product of the two vectors.

Calculates the dot product of two vectors.

First source vector. Second source vector. The dot product of the two vectors.

Converts the vector into a unit vector.

The vector to normalize. When the method completes, contains the normalized vector.

Converts the vector into a unit vector.

The vector to normalize. The normalized vector.

Performs a linear interpolation between two vectors.

Start vector. End vector. Value between 0 and 1 indicating the weight of . When the method completes, contains the linear interpolation of the two vectors. Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Performs a linear interpolation between two vectors.

Start vector. End vector. Value between 0 and 1 indicating the weight of . The linear interpolation of the two vectors. Passing a value of 0 will cause to be returned; a value of 1 will cause to be returned.

Performs a cubic interpolation between two vectors.

Start vector. End vector. Value between 0 and 1 indicating the weight of . When the method completes, contains the cubic interpolation of the two vectors.

Performs a cubic interpolation between two vectors.

Start vector. End vector. Value between 0 and 1 indicating the weight of . The cubic interpolation of the two vectors.

Performs a Hermite spline interpolation.

First source position vector. First source tangent vector. Second source position vector. Second source tangent vector. Weighting factor. When the method completes, contains the result of the Hermite spline interpolation.

Performs a Hermite spline interpolation.

First source position vector. First source tangent vector. Second source position vector. Second source tangent vector. Weighting factor. The result of the Hermite spline interpolation.

Performs a Catmull-Rom interpolation using the specified positions.

The first position in the interpolation. The second position in the interpolation. The third position in the interpolation. The fourth position in the interpolation. Weighting factor. When the method completes, contains the result of the Catmull-Rom interpolation.

Performs a Catmull-Rom interpolation using the specified positions.

The first position in the interpolation. The second position in the interpolation. The third position in the interpolation. The fourth position in the interpolation. Weighting factor. A vector that is the result of the Catmull-Rom interpolation.

Returns a vector containing the largest components of the specified vectors.

The first source vector. The second source vector. When the method completes, contains an new vector composed of the largest components of the source vectors.

Returns a vector containing the largest components of the specified vectors.

The first source vector. The second source vector. A vector containing the largest components of the source vectors.

Returns a vector containing the smallest components of the specified vectors.

The first source vector. The second source vector. When the method completes, contains an new vector composed of the smallest components of the source vectors.

Returns a vector containing the smallest components of the specified vectors.

The first source vector. The second source vector. A vector containing the smallest components of the source vectors.

Returns the reflection of a vector off a surface that has the specified normal.

The source vector. Normal of the surface. When the method completes, contains the reflected vector. Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it.

Returns the reflection of a vector off a surface that has the specified normal.

The source vector. Normal of the surface. The reflected vector. Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it.

Orthogonalizes a list of vectors.

The list of orthogonalized vectors. The list of vectors to orthogonalize. Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Thrown when or is null. Thrown when is shorter in length than .

Orthonormalizes a list of vectors.

The list of orthonormalized vectors. The list of vectors to orthonormalize. Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list. Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable. Thrown when or is null. Thrown when is shorter in length than .

Transforms a 2D vector by the given rotation.

The vector to rotate. The rotation to apply. When the method completes, contains the transformed .

Transforms a 2D vector by the given rotation.

The vector to rotate. The rotation to apply. The transformed .

Transforms an array of vectors by the given rotation.

The array of vectors to transform. The rotation to apply. The array for which the transformed vectors are stored. This array may be the same array as . Thrown when or is null. Thrown when is shorter in length than .

Transforms a 2D vector by the given .

The source vector. The transformation . When the method completes, contains the transformed .

Transforms a 2D vector by the given .

The source vector. The transformation . The transformed .

Transforms an array of 2D vectors by the given .

The array of vectors to transform. The transformation . The array for which the transformed vectors are stored. Thrown when or is null. Thrown when is shorter in length than .

Performs a coordinate transformation using the given .

The coordinate vector to transform. The transformation . When the method completes, contains the transformed coordinates. A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored.

Performs a coordinate transformation using the given .

The coordinate vector to transform. The transformation . The transformed coordinates. A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored.

Performs a coordinate transformation on an array of vectors using the given .

The array of coordinate vectors to transform. The transformation . The array for which the transformed vectors are stored. This array may be the same array as . Thrown when or is null. Thrown when is shorter in length than . A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored.

Performs a normal transformation using the given .

The normal vector to transform. The transformation . When the method completes, contains the transformed normal. A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.

Performs a normal transformation using the given .

The normal vector to transform. The transformation . The transformed normal. A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.

Performs a normal transformation on an array of vectors using the given .

The array of normal vectors to transform. The transformation . The array for which the transformed vectors are stored. This array may be the same array as . Thrown when or is null. Thrown when is shorter in length than . A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.

Adds two vectors.

The first vector to add. The second vector to add. The sum of the two vectors.

Multiplies a vector with another by performing component-wise multiplication equivalent to .

The first vector to multiply. The second vector to multiply. The multiplication of the two vectors.

Assert a vector (return it unchanged).

The vector to assert (unchanged). The asserted (unchanged) vector.

Subtracts two vectors.

The first vector to subtract. The second vector to subtract. The difference of the two vectors.

Reverses the direction of a given vector.

The vector to negate. A vector facing in the opposite direction.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Scales a vector by the given value.

The amount by which to scale the vector. The vector to scale. The scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Perform a component-wise addition

The input vector. The scalar value to be added on elements The vector with added scalar for each element.

Perform a component-wise addition

The input vector. The scalar value to be added on elements The vector with added scalar for each element.

Perform a component-wise subtraction

The input vector. The scalar value to be subtraced from elements The vector with subtraced scalar from each element.

Perform a component-wise subtraction

The input vector. The scalar value to be subtraced from elements The vector with subtraced scalar from each element.

Tests for equality between two objects.

The first value to compare. The second value to compare. true if has the same value as ; otherwise, false.

Tests for inequality between two objects.

The first value to compare. The second value to compare. true if has a different value than ; otherwise, false.

Performs an explicit conversion from to .

The value. The result of the conversion.

Performs an explicit conversion from to .

The value. The result of the conversion.

Returns a that represents this instance.

A that represents this instance.

Returns a that represents this instance.

The format. A that represents this instance.

Returns a that represents this instance.

The format provider. A that represents this instance.

Returns a that represents this instance.

The format. The format provider. A that represents this instance.

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Determines whether the specified is equal to this instance.

The to compare with this instance. true if the specified is equal to this instance; otherwise, false.

Represents a three dimensional mathematical vector.

A with all of its components set to zero.

The X unit (1, 0, 0).

The Y unit (0, 1, 0).

The Z unit (0, 0, 1).

A with all of its components set to one.

A unit designating up (0, 0, 1).

A unit designating down (0, 0, -1).

A unit designating left (-1, 0, 0).

A unit designating right (1, 0, 0).

A unit designating forward in a right-handed coordinate system (0, 1, 0).

A unit designating forward in a left-handed coordinate system (0, -1, 0).

A unit designating backward in a right-handed coordinate system (0, -1, 0).

A unit designating backward in a left-handed coordinate system (0, 1, 0).

The X component of the vector.

The Y component of the vector.

The Z component of the vector.

Initializes a new instance of the struct.

The value that will be assigned to all components.

Initializes a new instance of the struct.

Initial value for the X component of the vector. Initial value for the Y component of the vector. Initial value for the Z component of the vector.

Initializes a new instance of the struct.

A vector containing the values with which to initialize the X and Y components. Initial value for the Z component of the vector.

Initializes a new instance of the struct.

The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements. Thrown when is null. Thrown when contains more or less than three elements.

Gets a value indicting whether this instance is normalized.

Gets a value indicting whether this vector is zero

Gets or sets the component at the specified index.

The value of the X, Y, or Z component, depending on the index. The index of the component to access. Use 0 for the X component, 1 for the Y component, and 2 for the Z component. The value of the component at the specified index. Thrown when the is out of the range [0, 2].

Calculates the length of the vector.

The length of the vector. may be preferred when only the relative length is needed and speed is of the essence.

Calculates the squared length of the vector.

The squared length of the vector. This method may be preferred to when only a relative length is needed and speed is of the essence.

Converts the vector into a unit vector.

Creates an array containing the elements of the vector.

A three-element array containing the components of the vector.

Adds two vectors.

The first vector to add. The second vector to add. When the method completes, contains the sum of the two vectors.

Adds two vectors.

The first vector to add. The second vector to add. The sum of the two vectors.

Perform a component-wise addition

The input vector The scalar value to be added to elements The vector with added scalar for each element.

Perform a component-wise addition

The input vector The scalar value to be added to elements The vector with added scalar for each element.

Subtracts two vectors.

The first vector to subtract. The second vector to subtract. When the method completes, contains the difference of the two vectors.

Subtracts two vectors.

The first vector to subtract. The second vector to subtract. The difference of the two vectors.

Perform a component-wise subtraction

The input vector The scalar value to be subtraced from elements The vector with subtracted scalar for each element.

Perform a component-wise subtraction

The input vector The scalar value to be subtraced from elements The vector with subtracted scalar for each element.

Perform a component-wise subtraction

The scalar value to be subtraced from elements The input vector. The vector with subtracted scalar for each element.

Perform a component-wise subtraction

The scalar value to be subtraced from elements The input vector. The vector with subtracted scalar for each element.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. When the method completes, contains the scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Multiply a vector with another by performing component-wise multiplication.

The first vector to multiply. The second vector to multiply. When the method completes, contains the multiplied vector.

Multiply a vector with another by performing component-wise multiplication.

The first vector to Multiply. The second vector to multiply. The multiplied vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. When the method completes, contains the scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Scales a vector by the given value.

The amount by which to scale the vector. The vector to scale. When the method completes, contains the scaled vector.

Scales a vector by the given value.

The vector to scale. The amount by which to scale the vector. The scaled vector.

Reverses the direction of a given vector.

The vector to negate. When the method completes, contains a vector facing in the opposite direction.

Reverses the direction of a given vector.

The vector to negate. A vector facing in the opposite direction.

Returns a containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.

A containing the 3D Cartesian coordinates of vertex 1 of the triangle. A containing the 3D Cartesian coordinates of vertex 2 of the triangle. A containing the 3D Cartesian coordinates of vertex 3 of the triangle. Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). When the method completes, contains the 3D Cartesian coordinates of the specified point.

Returns a containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.

A containing the 3D Cartesian coordinates of vertex 1 of the triangle. A containing the 3D Cartesian coordinates of vertex 2 of the triangle. A containing the 3D Cartesian coordinates of vertex 3 of the triangle. Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in ). Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in ). A new containing the 3D Cartesian coordinates of the specified point.

Restricts a value to be within a specified range.

The value to clamp. The minimum value. The maximum value. When the method completes, contains the clamped value.

Restricts a value to be within a specified range.

The value to clamp. The minimum value. The maximum value. The clamped value.

Calculates the cross product of two vectors.

First source vector. Second source vector. When the method completes, contains he cross product of the two vectors.

Calculates the cross product of two vectors.

First source vector. Second source vector. The cross product of the two vectors.

Calculates the distance between two vectors.

The first vector. The second vector. When the method completes, contains the distance between the two vectors. may be preferred when only the relative distance is needed and speed is of the essence.

Calculates the distance between two vectors.

The first vector. The second vector. The distance between the two vectors. may be preferred when only the relative distance is needed and speed is of the essence.

Calculates the squared distance between two vectors.

The first vector. The second vector. When the method completes, contains the squared distance between the two vectors. Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots.

Calculates the squared distance between two vectors.

Tests whether one 3D vector is near another 3D vector.

The left vector. The right vector. The epsilon. true if left and right are near another 3D, false otherwise