CreateColCuboid - Revision history

Tracer: Added another example for centered cuboids

2024-01-31T14:29:28Z

Added another example for centered cuboids

← Older revision		Revision as of 14:29, 31 January 2024
Line 21:		Line 21:
	Returns a [[colshape]] element if successful, ''false'' if invalid arguments were passed to the function.		Returns a [[colshape]] element if successful, ''false'' if invalid arguments were passed to the function.

	==~~Example~~==		==Examples==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	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''.
Line 46:		Line 46:
	end		end
	addCommandHandler("set_zone", setZone, false, false)		addCommandHandler("set_zone", setZone, false, false)
			</syntaxhighlight>
			</section>

			<section name="Server" class="server" show="true">
			This function creates a cuboid and centers it to given coordinates
			<syntaxhighlight lang="lua">
			addCommandHandler('createCenteredCuboid', function(player, cmd, posX, posY, posZ, sizeX, sizeY, sizeZ)
			posX = posX - sizeX / 2
			posY = posY - sizeY / 2
			posZ = posZ - sizeZ / 2
			createCuboid(posX, posY, posZ, sizeX, sizeY, sizeZ)
			end)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

IManGaaX at 09:22, 6 November 2023

2023-11-06T09:22:49Z

← Older revision		Revision as of 09:22, 6 November 2023
Line 33:		Line 33:
	function setZone(playerSource, commandName, fX, fY, fZ, fWidth, fDepth, fHeight)		function setZone(playerSource, commandName, fX, fY, fZ, fWidth, fDepth, fHeight)
	local fX, fY, fZ, fWidth, fDepth, fHeight = tonumber(fX), tonumber(fY), tonumber(fZ), tonumber(fWidth), tonumber(fDepth), tonumber(fHeight)		local fX, fY, fZ, fWidth, fDepth, fHeight = tonumber(fX), tonumber(fY), tonumber(fZ), tonumber(fWidth), tonumber(fDepth), tonumber(fHeight)
	if (not fX) or (not fY) or (not fWidth) or (not fHeight) then		if (not fX) or (not fY) or (not fZ) or (not fWidth) or (not fDepth) or (not fHeight) then
	outputChatBox("Syntax: /"..commandName.." [X] [Y] [Z] [Width] [Depth] [Height]", playerSource)		outputChatBox("Syntax: /"..commandName.." [X] [Y] [Z] [Width] [Depth] [Height]", playerSource)
	else		else

IManGaaX at 09:22, 6 November 2023

2023-11-06T09:22:14Z

← Older revision		Revision as of 09:22, 6 November 2023
Line 32:		Line 32:

	function setZone(playerSource, commandName, fX, fY, fZ, fWidth, fDepth, fHeight)		function setZone(playerSource, commandName, fX, fY, fZ, fWidth, fDepth, fHeight)
	local fX, fY, fWidth, fDepth, fHeight = tonumber(fX), tonumber(fY), tonumber(fWidth), tonumber(fDepth), tonumber(fHeight)		local fX, fY, fZ, fWidth, fDepth, fHeight = tonumber(fX), tonumber(fY), tonumber(fZ), tonumber(fWidth), tonumber(fDepth), 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] [Depth] [Height]", playerSource)		outputChatBox("Syntax: /"..commandName.." [X] [Y] [Z] [Width] [Depth] [Height]", playerSource)
	else		else
	if (theZone ~= nil) then		if (theZone ~= nil) then
	destroyElement(theZone)		destroyElement(theZone)
	end		end
	local tempCol = createColCuboid(fX, fY, fWidth, fDepth, fHeight)		local tempCol = createColCuboid(fX, fY, fZ, fWidth, fDepth, fHeight)
	addEventHandler("onColShapeHit", tempCol, shapeHit)		addEventHandler("onColShapeHit", tempCol, shapeHit)
	outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", playerSource)		outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", playerSource)

IManGaaX: correct the example

2023-11-06T09:21:34Z

correct the example

← Older revision		Revision as of 09:21, 6 November 2023
Line 11:		Line 11:
	{{OOP\| \|ColShape.Cuboid\|\|}}		{{OOP\| \|ColShape.Cuboid\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''fX:''' The X position of the collision cuboid's western side		*'''fX:''' The X position of the collision cuboid's western side.
	*'''fY:''' The Y position of the collision cuboid's southern side		*'''fY:''' The Y position of the collision cuboid's southern side.
	*'''fZ:''' The Z position of the collision cuboid's lowest side		*'''fZ:''' The Z position of the collision cuboid's lowest side.
	*'''fWidth:''' The collision cuboid's width		*'''fWidth:''' The collision cuboid's width.
	*'''fDepth:''' The collision cuboid's depth		*'''fDepth:''' The collision cuboid's depth.
	*'''fHeight:''' The collision cuboid's height		*'''fHeight:''' The collision cuboid's height.

	===Returns===		===Returns===
Line 25:		Line 25:
	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, fZ )		function setZone(playerSource, commandName, fX, fY, fZ, fWidth, fDepth, fHeight)
	~~if ( fZ and~~ fY ~~and fX ) then -- check we've got all 3 args we need~~		local fX, fY, fWidth, fDepth, fHeight = tonumber(fX), tonumber(fY), tonumber(fWidth), tonumber(fDepth), tonumber(fHeight)
	~~local tempCol~~ = ~~createColCuboid~~ ( fX, fY, fZ, ~~10.0~~, ~~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] [Depth] [Height]", playerSource)
	~~outputConsole~~ ( "Syntax is: ~~set_zone <~~X~~> <~~Y~~> <Z>~~" ) ~~-- 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 -- store the new zone we've made~~
	~~outputChatBox ( "Zone has moved!" ) -- and tell everyone~~
	end		end
			local tempCol = createColCuboid(fX, fY, fWidth, fDepth, fHeight)
			addEventHandler("onColShapeHit", tempCol, shapeHit)
			outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", playerSource)
			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>

Turret001: edited example image description

2020-04-27T14:12:30Z

edited example image description

← Older revision		Revision as of 14:12, 27 April 2020
Line 8:		Line 8:
	colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )		colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )
	</syntaxhighlight>		</syntaxhighlight>
	[[File:Col-Cuboid.png\|thumb\|~~exmaple~~]]		[[File:Col-Cuboid.png\|thumb\|A cuboid created using this function]]
	{{OOP\| \|ColShape.Cuboid\|\|}}		{{OOP\| \|ColShape.Cuboid\|\|}}
	===Required Arguments===		===Required Arguments===

^iiEcoo'x ) at 12:36, 27 April 2020

2020-04-27T12:36:08Z

← Older revision		Revision as of 12:36, 27 April 2020
Line 8:		Line 8:
	colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )		colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )
	</syntaxhighlight>		</syntaxhighlight>
			[[File:Col-Cuboid.png\|thumb\|exmaple]]
	{{OOP\| \|ColShape.Cuboid\|\|}}		{{OOP\| \|ColShape.Cuboid\|\|}}
	===Required Arguments===		===Required Arguments===

Surge at 11:20, 9 October 2018

2018-10-09T11:20:09Z

← Older revision		Revision as of 11:20, 9 October 2018
Line 52:		Line 52:
	==See Also==		==See Also==
	{{Collision shape functions}}		{{Collision shape functions}}

			[[hu:createColCuboid]]

MarioKart: /* Syntax */ OOP syntax added

2014-07-21T05:37:32Z

Syntax: OOP syntax added

← Older revision		Revision as of 05:37, 21 July 2014
Line 8:		Line 8:
	colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )		colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\| \|ColShape.Cuboid\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''fX:''' The X position of the collision cuboid's western side		*'''fX:''' The X position of the collision cuboid's western side

Ccw at 18:33, 12 August 2013

2013-08-12T18:33:32Z

← Older revision		Revision as of 18:33, 12 August 2013
Line 3:		Line 3:
	This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See [http://en.wikipedia.org/wiki/Cuboid Wikipedia] for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.		This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See [http://en.wikipedia.org/wiki/Cuboid Wikipedia] for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.
	{{VisualizeColshape}}		{{VisualizeColshape}}
	{{Note\|Attaching a cuboid colshape to another element may give unexpected results as the origin is not at the cuboid centre. Try using a collision sphere for attaching instead}}		{{Note\|Attaching a cuboid colshape to another element may give unexpected results as the origin is not at the cuboid centre. Try using a [[createColSphere\|collision sphere]] for attaching instead}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ccw at 18:32, 12 August 2013

2013-08-12T18:32:20Z

← Older revision		Revision as of 18:32, 12 August 2013
Line 3:		Line 3:
	This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See [http://en.wikipedia.org/wiki/Cuboid Wikipedia] for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.		This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See [http://en.wikipedia.org/wiki/Cuboid Wikipedia] for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.
	{{VisualizeColshape}}		{{VisualizeColshape}}
			{{Note\|Attaching a cuboid colshape to another element may give unexpected results as the origin is not at the cuboid centre. Try using a collision sphere for attaching instead}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">