Constraint.Rope

{{Lua_function |
  function_name        = constraint.Rope |
  arguments            = {{Arg|Entity}} Ent1, {{Arg|Entity}} Ent2, {{Arg|Number}} Bone1, {{Arg|Number}} Bone2, {{Arg|Vector}} LPos1, {{Arg|Vector}} LPos2, {{Arg|Number}} length, {{Arg|Number}} addlength, {{Arg|Number}} forcelimit, {{Arg|Number}} width, {{Arg|String}} material, {{Arg|Boolean}} rigid |
  returns              = {{Arg|Entity}} constraint, {{Arg|Entity}} rope |
  description          = Creates a rope constraint. |
  library              = {{Arg|Constraint}} |
  lua_state            = {{Serverside}} |
}}
==Examples==
{{Lua example |
  description          = Taken from the Rope tool in toolgun. |
  useOn                = {{Serverside}}|
  code                 = <lua>
// Get client's CVars
local forcelimit = self:GetClientNumber( "forcelimit" )
local addlength	 = self:GetClientNumber( "addlength" )
local material 	 = self:GetClientInfo( "material" )
local width 	 = self:GetClientNumber( "width" ) 
local rigid	 	= self:GetClientNumber( "rigid" ) == 1
		
// Get information we're about to use
local Ent1,  Ent2  = self:GetEnt(1),	 self:GetEnt(2)
local Bone1, Bone2 = self:GetBone(1),	 self:GetBone(2)
local WPos1, WPos2 = self:GetPos(1),	 self:GetPos(2)
local LPos1, LPos2 = self:GetLocalPos(1),self:GetLocalPos(2)
local length = ( WPos1 - WPos2):Length()

local constraint, rope = constraint.Rope( Ent1, Ent2, Bone1, Bone2, LPos1, LPos2, length, addlength, forcelimit, width, material, rigid )
</lua> |}}

==Additional Notes==
* The first return value is false if either of the two entities cannot be constrained.
** An entity cannot be constrained if it's an invalid world brush or if the rope is being attached to an invalid physics object
**''If the first value is named constraint but is not local it will overwrite the actual constraint object, causing all constraint creation or removal to stop working''
* The first return value will be a keyframe_rope if you roping to the same bone on the same entity.

==See Also==
* {{Arg|Constraint}}
* [[constraint.Elastic]]