constraint.GetAllConstrainedEntities

From Garry's Mod
Revision as of 17:30, 25 May 2014 by Robotboy655 (Talk | contribs)
Jump to: navigation, search
 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