CreateColRectangle - Revision history

IManGaaX at 09:18, 6 November 2023

2023-11-06T09:18:19Z

← Older revision		Revision as of 09:18, 6 November 2023
Line 10:		Line 10:
	{{OOP\| \|ColShape.Rectangle\|\|}}		{{OOP\| \|ColShape.Rectangle\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''fX:''' The X position of the collision rectangle's west side		*'''fX:''' The X position of the collision rectangle's west side.
	*'''fY:''' The Y position of the collision rectangle's south side		*'''fY:''' The Y position of the collision rectangle's south side.
	*'''fWidth:''' The collision rectangle's width		*'''fWidth:''' The collision rectangle's width.
	*'''fHeight:''' The collision rectangle's height		*'''fHeight:''' The collision rectangle's height.

	===Returns===		===Returns===
Line 31:		Line 31:
	local fX, fY, fWidth, fHeight = tonumber(fX), tonumber(fY), tonumber(fWidth), tonumber(fHeight)		local fX, fY, fWidth, fHeight = tonumber(fX), tonumber(fY), tonumber(fWidth), tonumber(fHeight)
	if (not fX) or (not fY) or (not fWidth) or (not fHeight) then		if (not fX) or (not fY) or (not fWidth) or (not fHeight) then
	outputChatBox("Syntax: /"..commandName.." [X] [Y] [Width] [Height]", ~~thePlayer~~)		outputChatBox("Syntax: /"..commandName.." [X] [Y] [Width] [Height]", playerSource)
	else		else
	if (theZone ~= nil) then		if (theZone ~= nil) then
Line 38:		Line 38:
	local tempCol = createColRectangle(fX, fY, fWidth, fHeight)		local tempCol = createColRectangle(fX, fY, fWidth, fHeight)
	addEventHandler("onColShapeHit", tempCol, shapeHit)		addEventHandler("onColShapeHit", tempCol, shapeHit)
	outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", ~~thePlayer~~)		outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", playerSource)
	theZone = tempCol		theZone = tempCol
	end		end

IManGaaX: correct the example

2023-11-06T09:11:38Z

correct the example

← Older revision		Revision as of 09:11, 6 November 2023
Line 22:		Line 22:
	This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function ''set_zone''.		This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function ''set_zone''.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	theZone ~~= false~~		local theZone

	function shapeHit ( thePlayer )		function shapeHit(thePlayer)
	outputChatBox ( getPlayerName ( thePlayer ) .. " is in the zone!" ) ~~-- display a message in everyone's chat box~~		outputChatBox(getPlayerName(thePlayer).. " is in the zone!")
	end		end

	function setZone ( playerSource, commandName, fX, fY )		function setZone(playerSource, commandName, fX, fY, fWidth, fHeight)
	~~if (~~ fY ~~and fX ) then -- check we've got the 2 args we need~~		local fX, fY, fWidth, fHeight = tonumber(fX), tonumber(fY), tonumber(fWidth), tonumber(fHeight)
	~~local tempCol~~ = ~~createColRectangle~~ ( fX, fY, ~~10.0~~, ~~10.0~~ ) ~~-- create a col~~		if (not fX) or (not fY) or (not fWidth) or (not fHeight) then
	if ( ~~tempCol == false~~ ) then ~~-- did the col get created successfully?~~		outputChatBox("Syntax: /"..commandName.." [X] [Y] [Width] [Height]", thePlayer)
	~~outputConsole~~ ( "Syntax is: ~~set_zone <~~X~~> <~~Y>" ) ~~-- inform the user what the valid syntax is~~		else
	else		if (theZone ~= nil) then
	if ( theZone ~= ~~false~~ ) then ~~-- did we already have a zone?~~		destroyElement(theZone)
	destroyElement ( theZone ) ~~-- if so, destroy it~~
	~~else~~
	~~addEventHandler ( "onColShapeHit", theZone, shapeHit ) -- add a handler for the onColShapeHit event~~
	~~end~~
	~~theZone = tempCol -- and store the new zone we've made~~
	~~outputChatBox ( "Zone has moved!" ) -- and tell everyone~~
	end		end
			local tempCol = createColRectangle(fX, fY, fWidth, fHeight)
			addEventHandler("onColShapeHit", tempCol, shapeHit)
			outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", thePlayer)
			theZone = tempCol
	end		end
	end		end
	addCommandHandler ( "set_zone", setZone ) ~~-- add a console function called set_zone that will trigger the function setZone~~		addCommandHandler("set_zone", setZone, false, false)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Surge at 10:06, 10 October 2018

2018-10-10T10:06:35Z

← Older revision		Revision as of 10:06, 10 October 2018
Line 50:		Line 50:
	==See Also==		==See Also==
	{{Collision shape functions}}		{{Collision shape functions}}

			[[hu:createColRectangle]]

Myonlake: /* Syntax */

2018-06-27T23:03:10Z

Syntax

← Older revision		Revision as of 23:03, 27 June 2018
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	colshape createColRectangle ( float fX, float fY, float fWidth, float fHeight)		colshape createColRectangle ( float fX, float fY, float fWidth, float fHeight )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\| \|ColShape.Rectangle\|\|}}		{{OOP\| \|ColShape.Rectangle\|\|}}

MarioKart: /* Syntax */ OOP syntax added

2014-07-21T05:38:55Z

Syntax: OOP syntax added

← Older revision		Revision as of 05:38, 21 July 2014
Line 8:		Line 8:
	colshape createColRectangle ( float fX, float fY, float fWidth, float fHeight)		colshape createColRectangle ( float fX, float fY, float fWidth, float fHeight)
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\| \|ColShape.Rectangle\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''fX:''' The X position of the collision rectangle's west side		*'''fX:''' The X position of the collision rectangle's west side

Ccw at 18:43, 12 August 2013

2013-08-12T18:43:49Z

← Older revision		Revision as of 18:43, 12 August 2013
Line 3:		Line 3:
	This function creates a collision rectangle. This is a shape that has a position and a width and a depth. See [http://en.wikipedia.org/wiki/Rectangle Rectangle] for a definition of a rectangle. XY marks on the south west corner of the colshape.		This function creates a collision rectangle. This is a shape that has a position and a width and a depth. See [http://en.wikipedia.org/wiki/Rectangle Rectangle] for a definition of a rectangle. XY marks on the south west corner of the colshape.
	{{VisualizeColshape}}		{{VisualizeColshape}}
			{{Note\|Attaching a rectangle colshape to another element may give unexpected results as the origin is not at the rectangle centre. Try using a [[createColCircle\|collision circle]] for attaching instead}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Kenix1 at 18:40, 19 March 2012

2012-03-19T18:40:27Z

← Older revision		Revision as of 18:40, 19 March 2012
Line 13:		Line 13:
	*'''fWidth:''' The collision rectangle's width		*'''fWidth:''' The collision rectangle's width
	*'''fHeight:''' The collision rectangle's height		*'''fHeight:''' The collision rectangle's height

	~~NOTICE:~~
	~~Width and height must be positive value.~~

	===Returns===		===Returns===

Kenix1 at 18:39, 19 March 2012

2012-03-19T18:39:49Z

← Older revision		Revision as of 18:39, 19 March 2012
Line 13:		Line 13:
	*'''fWidth:''' The collision rectangle's width		*'''fWidth:''' The collision rectangle's width
	*'''fHeight:''' The collision rectangle's height		*'''fHeight:''' The collision rectangle's height

			NOTICE:
			Width and height must be positive value.

	===Returns===		===Returns===

Ccw at 11:12, 19 November 2011

2011-11-19T11:12:42Z

← Older revision		Revision as of 11:12, 19 November 2011
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	This function creates a collision rectangle. This is a shape that has a position and a width and a depth. See [http://en.wikipedia.org/wiki/Rectangle Rectangle] for a definition of a rectangle. XY marks on the south west corner of the colshape.		This function creates a collision rectangle. This is a shape that has a position and a width and a depth. See [http://en.wikipedia.org/wiki/Rectangle Rectangle] for a definition of a rectangle. XY marks on the south west corner of the colshape.
			{{VisualizeColshape}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

MaddDogg: west - south mix up | renamed fDepth to fHeight

2011-02-04T11:45:35Z

west - south mix up | renamed fDepth to fHeight

← Older revision		Revision as of 11:45, 4 February 2011
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	colshape createColRectangle ( float fX, float fY, float fWidth, float ~~fDepth~~ )		colshape createColRectangle ( float fX, float fY, float fWidth, float fHeight)
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''fX:''' The X position of the collision rectangle's ~~south~~ side		*'''fX:''' The X position of the collision rectangle's west side
	*'''fY:''' The Y position of the collision rectangle's ~~west~~ side		*'''fY:''' The Y position of the collision rectangle's south side
	*'''fWidth:''' The collision rectangle's width		*'''fWidth:''' The collision rectangle's width
	*'''~~fDepth~~:''' The collision rectangle's ~~depth~~		*'''fHeight:''' The collision rectangle's height

	===Returns===		===Returns===