GetPlayerMapBoundingBox - Revision history

Fernando187 at 11:51, 9 November 2024

2024-11-09T11:51:00Z

← Older revision		Revision as of 11:51, 9 November 2024
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function gets the GUI bounding box of the ~~radar~~ map texture.		This function gets the GUI bounding box of the player map (F11) texture.

	==Syntax==		==Syntax==
Line 54:		Line 54:
	</syntaxhighlight>		</syntaxhighlight>

	This example lets players set a target blip in their ~~radar~~ by clicking with the left mouse button in the desired place in the F11 world map, and delete it by clicking with the right mouse button.		This example lets players set a target blip in their map by clicking with the left mouse button in the desired place in the F11 world map, and delete it by clicking with the right mouse button.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local targetBlipIcon = 41 -- The target blip icon to use. Defaults to the Waypoint icon		local targetBlipIcon = 41 -- The target blip icon to use. Defaults to the Waypoint icon

AlexTMjugador: Better variable naming

2016-07-02T17:39:41Z

Better variable naming

← Older revision		Revision as of 17:39, 2 July 2016
Line 32:		Line 32:
	end		end
	end		end

	-- Calculate a factor in range [0, 1] which represents the relative distance to the max world coords point from the min world coords point of the given coordinates (worldPos)		-- Calculate a factor in range [0, 1] which represents the relative distance to the max world coords point from the min world coords point of the given coordinates (worldPos)
	-- 0 means that the given point is in mapMin in a certain direction		-- 0 means that the given point is in mapMin in a certain direction
Line 40:		Line 40:
	-- Do the opposite thing for the min coords point		-- Do the opposite thing for the min coords point
	local fmx, fmy = 1 - fMx, 1 - fMy		local fmx, fmy = 1 - fMx, 1 - fMy

	-- Use the factors and given screen points to calculate the final screen coords of our world position in the map		-- Use the factors and given screen points to calculate the final screen coords of our world position in the map
	local screenMapPos = Vector2((fmx * mapMin.x) + (fMx * mapMax.x), (fmy * mapMin.y) + (fMy * mapMax.y))		local screenMapPos = Vector2((fmx * mapMin.x) + (fMx * mapMax.x), (fmy * mapMin.y) + (fMy * mapMax.y))

	-- Check whether our screen position is within the viewable screen area (this is not necessary when working with dxDrawText anyway)		-- Check whether our screen position is within the viewable screen area (this is not necessary when working with dxDrawText anyway)
	if screenMapPos.x >= 0 and screenMapPos.y >= 0 and screenMapPos.x <= screenSize.x and screenMapPos.y <= screenSize.y then		if screenMapPos.x >= 0 and screenMapPos.y >= 0 and screenMapPos.x <= screenSize.x and screenMapPos.y <= screenSize.y then
Line 59:		Line 59:

	local screenSize = Vector2(guiGetScreenSize())		local screenSize = Vector2(guiGetScreenSize())
	local ~~wasLeftMouseButtonClicked~~, ~~wasRightMouseButtonClicked~~, targetBlip = false, false		local wasLeftMouseButtonPressed, wasRightMouseButtonPressed, targetBlip = false, false

	local function handleMapTargetBlip()		local function handleMapTargetBlip()
Line 65:		Line 65:
	if not isPlayerMapVisible() then		if not isPlayerMapVisible() then
	showCursor(false, false)		showCursor(false, false)
	~~wasLeftMouseButtonClicked~~, ~~wasRightMouseButtonClicked~~ = false, false		wasLeftMouseButtonPressed, wasRightMouseButtonPressed = false, false
	return		return
	end		end

	-- If the cursor is not showing, show it, so the player can click on the desired target point		-- If the cursor is not showing, show it, so the player can click on the desired target point
	if not isCursorShowing() then		if not isCursorShowing() then
	showCursor(true, false)		showCursor(true, false)
	end		end

	-- If we have just started to click the left mouse button, do the actual target blip creation		-- If we have just started to click the left mouse button, do the actual target blip creation
	local ~~isLeftMouseButtonClicked~~ = getKeyState("mouse1")		local isLeftMouseButtonPressed = getKeyState("mouse1")
	if ~~isLeftMouseButtonClicked~~ and ~~isLeftMouseButtonClicked~~ ~= ~~wasLeftMouseButtonClicked~~ then		if isLeftMouseButtonPressed and isLeftMouseButtonPressed ~= wasLeftMouseButtonPressed then
	-- Get the cursor and map bounding box positions		-- Get the cursor and map bounding box positions
	local cursorPos, mapMin, mapMax = Vector2(getCursorPosition())		local cursorPos, mapMin, mapMax = Vector2(getCursorPosition())

	-- Transform the relative cursor position to absolute position		-- Transform the relative cursor position to absolute position
	cursorPos.x, cursorPos.y = cursorPos.x * screenSize.x, cursorPos.y * screenSize.y		cursorPos.x, cursorPos.y = cursorPos.x * screenSize.x, cursorPos.y * screenSize.y

	-- Calculate our map points vectors inside a block to delete intermediate variables automatically		-- Calculate our map points vectors inside a block to delete intermediate variables automatically
	do		do
Line 89:		Line 89:
	mapMax = Vector2(Mx, My)		mapMax = Vector2(Mx, My)
	end		end

	-- If the cursor is inside the map rectangle, create or update the target blip		-- If the cursor is inside the map rectangle, create or update the target blip
	-- Otherwise, just ignore the click		-- Otherwise, just ignore the click
Line 97:		Line 97:
	-- 1 in a direction means that the cursor is in mapMax in that direction		-- 1 in a direction means that the cursor is in mapMax in that direction
	local relPos = Vector2((cursorPos.x - mapMin.x) / (mapMax.x - mapMin.x), (cursorPos.y - mapMin.y) / (mapMax.y - mapMin.y))		local relPos = Vector2((cursorPos.x - mapMin.x) / (mapMax.x - mapMin.x), (cursorPos.y - mapMin.y) / (mapMax.y - mapMin.y))

	-- Translate that relative position to 2D world coordinates		-- Translate that relative position to 2D world coordinates
	-- Assumes the world map is a square whose side is 6000 units long		-- Assumes the world map is a square whose side is 6000 units long
	local worldPlanePos = Vector2(6000 * (relPos.x - 0.5), 3000 - (relPos.y * 6000))		local worldPlanePos = Vector2(6000 * (relPos.x - 0.5), 3000 - (relPos.y * 6000))

	-- Get a 3D world position by adding the highest ground Z coordinate, which is what we usually want		-- Get a 3D world position by adding the highest ground Z coordinate, which is what we usually want
	-- Note that only the blip ID 0 (marker) uses this additional coordinate. For the rest of blips, we could pass a dummy value instead		-- Note that only the blip ID 0 (marker) uses this additional coordinate. For the rest of blips, we could pass a dummy value instead
	local worldPos = Vector3(worldPlanePos.x, worldPlanePos.y, getGroundPosition(worldPlanePos.x, worldPlanePos.y, 3000))		local worldPos = Vector3(worldPlanePos.x, worldPlanePos.y, getGroundPosition(worldPlanePos.x, worldPlanePos.y, 3000))

	-- If we don't have a target blip, create it. Otherwise, just update its position		-- If we don't have a target blip, create it. Otherwise, just update its position
	if not targetBlip then		if not targetBlip then
Line 114:		Line 114:
	end		end
	end		end

	-- If we have a target blip, destroy it and its variable if we have just started to click the right mouse button		-- If we have a target blip, destroy it and its variable if we have just started to click the right mouse button
	local ~~isRightMouseButtonClicked~~ = getKeyState("mouse2")		local isRightMouseButtonPressed = getKeyState("mouse2")
	if targetBlip then		if targetBlip then
	if ~~isRightMouseButtonClicked~~ and ~~isRightMouseButtonClicked~~ ~= ~~wasRightMouseButtonClicked~~ then		if isRightMouseButtonPressed and isRightMouseButtonPressed ~= wasRightMouseButtonPressed then
	destroyElement(targetBlip)		destroyElement(targetBlip)
	targetBlip = nil		targetBlip = nil
	end		end
	end		end

	-- Save the mouse button states for future checks		-- Save the mouse button states for future checks
	~~wasLeftMouseButtonClicked~~, ~~wasRightMouseButtonClicked~~ = ~~isLeftMouseButtonClicked~~, ~~isRightMouseButtonClicked~~		wasLeftMouseButtonPressed, wasRightMouseButtonPressed = isLeftMouseButtonPressed, isRightMouseButtonPressed
	end		end
	addEventHandler("onClientRender", root, handleMapTargetBlip)		addEventHandler("onClientRender", root, handleMapTargetBlip)

AlexTMjugador at 17:23, 2 July 2016

2016-07-02T17:23:03Z

← Older revision		Revision as of 17:23, 2 July 2016
Line 65:		Line 65:
	if not isPlayerMapVisible() then		if not isPlayerMapVisible() then
	showCursor(false, false)		showCursor(false, false)
	~~mouseWasClicked~~ = false		wasLeftMouseButtonClicked, wasRightMouseButtonClicked = false, false
	return		return
	end		end

AlexTMjugador at 17:15, 2 July 2016

2016-07-02T17:15:38Z

← Older revision		Revision as of 17:15, 2 July 2016
Line 116:		Line 116:

	-- If we have a target blip, destroy it and its variable if we have just started to click the right mouse button		-- If we have a target blip, destroy it and its variable if we have just started to click the right mouse button
			local isRightMouseButtonClicked = getKeyState("mouse2")
	if targetBlip then		if targetBlip then
	~~local isRightMouseButtonClicked = getKeyState("mouse2")~~
	if isRightMouseButtonClicked and isRightMouseButtonClicked ~= wasRightMouseButtonClicked then		if isRightMouseButtonClicked and isRightMouseButtonClicked ~= wasRightMouseButtonClicked then
	destroyElement(targetBlip)		destroyElement(targetBlip)

AlexTMjugador: Corrected wrong fact about minX and maxY, added another example to translate screen coordinates on the map to world coordinates

2016-07-02T17:08:40Z

Corrected wrong fact about minX and maxY, added another example to translate screen coordinates on the map to world coordinates

Show changes

AlexTMjugador at 15:15, 30 June 2016

2016-06-30T15:15:00Z

← Older revision		Revision as of 15:15, 30 June 2016
Line 45:		Line 45:

	-- Check whether our screen position is within the viewable screen area (this is not necessary when working with dxDrawText anyway)		-- Check whether our screen position is within the viewable screen area (this is not necessary when working with dxDrawText anyway)
	if screenMapPos.x > 0 and screenMapPos.y > 0 and screenMapPos.x <= screenSize.x and screenMapPos.y <= screenSize.y then		if screenMapPos.x >= 0 and screenMapPos.y >= 0 and screenMapPos.x <= screenSize.x and screenMapPos.y <= screenSize.y then
	-- Finally, draw our desired text		-- Finally, draw our desired text
	local width = dxGetTextWidth("Center of SA map")		local width = dxGetTextWidth("Center of SA map")

AlexTMjugador: Added example, finally

2016-06-30T15:12:21Z

Added example, finally

← Older revision		Revision as of 15:12, 30 June 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~{{Needs Example}}~~
	This function gets the GUI bounding box of the radar map texture.		This function gets the GUI bounding box of the radar map texture.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int,int,int,int getPlayerMapBoundingBox ()</syntaxhighlight>		<syntaxhighlight lang="lua">int, int, int, int getPlayerMapBoundingBox ()</syntaxhighlight>

	===Returns===		===Returns===
	* If the player's map is showing, it returns four integers: ''minX'', ''minY'', ''maxX'', ''maxY''. These are '''absolute''' position coordinates of where the player's map is drawn on the screen		* If the player's map is showing, it returns four integers: ''minX'', ''minY'', ''maxX'', ''maxY''. These are '''absolute''' position coordinates of where the player's map is drawn on the screen.
	** ''minX,minY'' represent the world ~~coordinate~~ ''-3000,-3000''		** ''minX, minY'' represent the world coordinates ''-3000, -3000''.
	** ''maxX,maxY'' represent the world ~~coordinate~~ ''3000,3000''.		** ''maxX, maxY'' represent the world coordinates ''3000, 3000''.
	** Negative values may be returned if these coordinates are off screen.		** Negative values may be returned if these coordinates are off screen.
	* If the map ~~was~~ not showing, a ''false'' boolean value is returned.		* If the map is not showing, a ''false'' boolean value is returned.


	==Example==		==Example==
			This example draws the text "Center of SA map" in the F11 map screen where the center of world coordinates is.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~Needs an example~~		local centerPos = Vector2(0, 0) -- Somewhere in Blueberry Acres
			local screenSize = Vector2(guiGetScreenSize())

			local function drawCenterPosMapText()
			local mapMin, mapMax
			do
			-- We do these operations inside a block to delete intermediate variables automatically
			local mx, my, Mx, My = getPlayerMapBoundingBox()
			if mx then
			mapMin = Vector2(mx, my)
			mapMax = Vector2(Mx, My)
			else
			-- Do not continue if the screen coordinates could not be calculated (i.e. map is not showing)
			return
			end
			end

			-- Calculate a factor in range [0, 1] which represents the relative distance to the max coords point from the min coords point of the given coordinates (centerPos)
			-- 0 means that the given point is in mapMin in a certain direction
			-- 1 means that the given point is in mapMax in a certain direction
			-- Assumes the world map is a square whose side is 6000 units long
			local fMx, fMy = (centerPos.x + 3000) / 6000, (centerPos.y + 3000) / 6000
			-- Do the opposite thing for the min coords point
			local fmx, fmy = 1 - fMx, 1 - fMy

			-- Use the factors and given screen points to calculate the final screen coords of our world position in the map
			local screenMapPos = Vector2((fmx * mapMin.x) + (fMx * mapMax.x), (fmy * mapMin.y) + (fMy * mapMax.y))

			-- Check whether our screen position is within the viewable screen area (this is not necessary when working with dxDrawText anyway)
			if screenMapPos.x > 0 and screenMapPos.y > 0 and screenMapPos.x <= screenSize.x and screenMapPos.y <= screenSize.y then
			-- Finally, draw our desired text
			local width = dxGetTextWidth("Center of SA map")
			dxDrawText("Center of SA map", screenMapPos.x - (width / 2), screenMapPos.y, screenMapPos.x + (width / 2), screenMapPos.y, tocolor(255, 255, 0), 1, "default", "center")
			end
			end
			addEventHandler("onClientRender", root, drawCenterPosMapText)
	</syntaxhighlight>		</syntaxhighlight>

	==See ~~Also~~==		==See also==
	{{Client player functions}}		{{Client player functions}}

FuSioN at 01:41, 16 February 2015

2015-02-16T01:41:21Z

← Older revision		Revision as of 01:41, 16 February 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
			{{Needs Example}}
	This function gets the GUI bounding box of the radar map texture.		This function gets the GUI bounding box of the radar map texture.

Talidan at 16:54, 15 January 2009

2009-01-15T16:54:08Z

← Older revision		Revision as of 16:54, 15 January 2009
Line 10:		Line 10:
	** ''minX,minY'' represent the world coordinate ''-3000,-3000''		** ''minX,minY'' represent the world coordinate ''-3000,-3000''
	** ''maxX,maxY'' represent the world coordinate ''3000,3000''.		** ''maxX,maxY'' represent the world coordinate ''3000,3000''.
	** Negative values ~~are~~ returned if these coordinates are off screen.		** Negative values may be returned if these coordinates are off screen.
	* If the map was not showing, a ''false'' boolean value is returned.		* If the map was not showing, a ''false'' boolean value is returned.

Talidan: New page: NOTOC {{Client function}} This function gets the GUI bounding box of the radar map texture. ==Syntax== int,int,int,int getPlayerMapBoundingBox () ===Returns=== * ...

2009-01-15T12:11:57Z

New page: __NOTOC__ {{Client function}} This function gets the GUI bounding box of the radar map texture. ==Syntax== <syntaxhighlight lang="lua">int,int,int,int getPlayerMapBoundingBox ()</syntaxhighlight> ===Returns=== * ...

New page

__NOTOC__
{{Client function}}
This function gets the GUI bounding box of the radar map texture.

==Syntax==
<syntaxhighlight lang="lua">int,int,int,int getPlayerMapBoundingBox ()</syntaxhighlight>

===Returns===
* If the player's map is showing, it returns four integers: ''minX'', ''minY'', ''maxX'', ''maxY''. These are '''absolute''' position coordinates of where the player's map is drawn on the screen
** ''minX,minY'' represent the world coordinate ''-3000,-3000''
** ''maxX,maxY'' represent the world coordinate ''3000,3000''.
** Negative values are returned if these coordinates are off screen.
* If the map was not showing, a ''false'' boolean value is returned.

==Example==
<syntaxhighlight lang="lua">
--Needs an example
</syntaxhighlight>

==See Also==
{{Client player functions}}