constraint/GetAllConstrainedEntities

From Garry's Mod
(Difference between revisions)
Jump to: navigation, search
Line 19: Line 19:
 
{{Ret
 
{{Ret
 
|type=table
 
|type=table
|desc=ResultTable
+
|desc=A table containing all of the constrained entities. This includes all entities constrained to entities constrained to the supplied entity, etc.
 
}}
 
}}
 
{{Example
 
{{Example
| Description = Adapted from stools/remover.lua
+
|Description=Adapted from stools/remover.lua
| Code = -- Remove this entity and everything constrained
+
|Code=-- Remove this entity and everything constrained
 
function TOOL:RightClick( trace )
 
function TOOL:RightClick( trace )
if ( !IsValid( trace.Entity ) or trace.Entity:IsPlayer() ) then return false end
+
if ( !IsValid( trace.Entity ) or trace.Entity:IsPlayer() ) then return false end
-- Loop through all the entities in the system
+
-- Loop through all the entities in the system
for _, Entity in pairs( constraint.GetAllConstrainedEntities( trace.Entity ) ) do
+
for _, Entity in pairs( constraint.GetAllConstrainedEntities( trace.Entity ) ) do
DoRemoveEntity( Entity )
+
DoRemoveEntity( Entity )
end
+
end
return true
+
return true
 
end
 
end
 
}}
 
}}

Revision as of 17:30, 25 May 2014

 constraint.GetAllConstrainedEntities( )

Contents

Description

Returns a table of all entities recursively constrained to an entitiy.

Arguments

Entity ent

The entity to check

Arguments

table ResultTable=nil

Table used to return result. Optional.

Returns

table

A table containing all of the constrained entities. This includes all entities constrained to entities constrained to the supplied entity, etc.

Examples

Example

Adapted from stools/remover.lua

-- Remove this entity and everything constrained
function TOOL:RightClick( trace )
	if ( !IsValid( trace.Entity ) or trace.Entity:IsPlayer() ) then return false end
	-- Loop through all the entities in the system
	for _, Entity in pairs( constraint.GetAllConstrainedEntities( trace.Entity ) ) do
		DoRemoveEntity( Entity )
	end
	return true
end


Personal tools
Navigation