Skip to content

Colshape ​

An invisible zone owned by the creating resource and removed when that resource stops. Raises colshape_enter and colshape_leave. Reads on a removed colshape return nil, err.

Colshape:id ​

Returns id integer

Colshape:players ​

Returns the players currently inside: alive, spawned and in the colshape's world.

Returns players Player[]|nil, err string|nil

Colshape:vehicles ​

Returns the vehicles currently inside: not wrecked and in the colshape's world.

Returns vehicles Vehicle[]|nil, err string|nil

Colshape:form ​

Returns the form in the format create_colshape accepts, without the world.

Returns form ColshapeForm|nil, err string|nil

Colshape:set_form ​

Replaces the form with one of any kind. Occupancy is re-evaluated immediately and raises the colshape's events; setting the same form again does nothing.

Parameters

Returns ok boolean|nil, err string|nil

Colshape:show ​

Shows the colshape's outline to the player; the client draws it during an edit session. By default, no player sees it. The setting is per player and ends when the player leaves. The outline does not reveal who is inside.

Parameters

Returns ok boolean|nil, err string|nil

Colshape:hide ​

Parameters

Returns ok boolean|nil, err string|nil

Documentation licensed under CC BY 4.0. DarqlineMP is not affiliated with Rockstar Games or Take-Two Interactive. Grand Theft Auto is a trademark of Take-Two Interactive Software, Inc.