TakePlayerScreenShot - Revision history

Fernando187: /* Example */

2025-06-08T13:51:43Z

Example

← Older revision		Revision as of 13:51, 8 June 2025
Line 22:		Line 22:
	Returns ''true'' if the function was successfully, ''false'' if invalid arguments are specified.		Returns ''true'' if the function was successfully, ''false'' if invalid arguments are specified.

	==~~Example~~==		==Examples==
	~~===Example 1===~~
	This example will take a player screenshot whenever a player takes a picture with the camera weapon and then send the picture to all clients, which will render the latest screenshot in the bottom right corner of their screen.		This example will take a player screenshot whenever a player takes a picture with the camera weapon and then send the picture to all clients, which will render the latest screenshot in the bottom right corner of their screen.

DColeman: Use client instead of source in example

2025-05-10T19:06:06Z

Use client instead of source in example

← Older revision		Revision as of 19:06, 10 May 2025
Line 62:		Line 62:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function requestScreenshot()		function requestScreenshot()
	takePlayerScreenShot(~~source~~,320,240,"cameraphoto",50) -- the player just took a picture with the camera, let's request a screenshot to see what they took a photo of		takePlayerScreenShot(client,320,240,"cameraphoto",50) -- the player just took a picture with the camera, let's request a screenshot to see what they took a photo of
	end		end
	addEvent("onPlayerTakesPhoto",true)		addEvent("onPlayerTakesPhoto",true)

Fernando187: Remove obsolete Requirements section

2024-11-07T15:41:01Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:41, 7 November 2024
Line 75:		Line 75:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~==Requirements==~~
	~~{{Requirements\|1.3\|n/a\|}}~~

	==See Also==		==See Also==
	{{Player functions\|server}}		{{Player functions\|server}}

FileEX: /* See Also */

2024-09-06T22:45:01Z

Srslyyyy: Replace to predefined variables.

2023-06-26T10:01:28Z

Replace to predefined variables.

← Older revision		Revision as of 10:01, 26 June 2023
Line 34:		Line 34:
	function wepFire(weapon)		function wepFire(weapon)
	if weapon == 43 then -- if the weapon the player just fired is the camera		if weapon == 43 then -- if the weapon the player just fired is the camera
	triggerServerEvent("onPlayerTakesPhoto",~~getLocalPlayer()~~)		triggerServerEvent("onPlayerTakesPhoto",localPlayer)
	end		end
	end		end
	addEventHandler("onClientPlayerWeaponFire",~~getLocalPlayer()~~,wepFire)		addEventHandler("onClientPlayerWeaponFire",localPlayer,wepFire)

	function updateLatestPhoto(img)		function updateLatestPhoto(img)
Line 47:		Line 47:
	end		end
	addEvent("updatePhoto",true)		addEvent("updatePhoto",true)
	addEventHandler("updatePhoto",~~getRootElement()~~,updateLatestPhoto)		addEventHandler("updatePhoto",root,updateLatestPhoto)

	function renderPhoto()		function renderPhoto()
Line 56:		Line 56:
	end		end
	end		end
	addEventHandler("onClientRender",~~getRootElement()~~,renderPhoto)		addEventHandler("onClientRender",root,renderPhoto)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
Line 65:		Line 65:
	end		end
	addEvent("onPlayerTakesPhoto",true)		addEvent("onPlayerTakesPhoto",true)
	addEventHandler("onPlayerTakesPhoto",~~getRootElement()~~,requestScreenshot)		addEventHandler("onPlayerTakesPhoto",root,requestScreenshot)

	function incomingPlayerScreenshot(res,status,img,timestamp,tag)		function incomingPlayerScreenshot(res,status,img,timestamp,tag)
Line 72:		Line 72:
	end		end
	end		end
	addEventHandler("onPlayerScreenShot",~~getRootElement()~~,incomingPlayerScreenshot)		addEventHandler("onPlayerScreenShot",root,incomingPlayerScreenshot)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Dmi7ry at 06:38, 17 June 2023

2023-06-17T06:38:03Z

← Older revision		Revision as of 06:38, 17 June 2023
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int ~~maxBandwith~~ = 5000, int maxPacketSize = 500 ] )		bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwidth = 5000, int maxPacketSize = 500 ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[player]]:takeScreenShot\|\|}}		{{OOP\|\|[[player]]:takeScreenShot\|\|}}
Line 16:		Line 16:
	*'''tag:''' A string to help identify the screen capture. The string is passed to the matching [[onPlayerScreenShot]] event for your personal convenience.		*'''tag:''' A string to help identify the screen capture. The string is passed to the matching [[onPlayerScreenShot]] event for your personal convenience.
	*'''quality:''' Quality of the final JPEG image from 0 to 100. A lower value can reduce the memory used by the image considerably which will result in faster and less intrusive uploads.		*'''quality:''' Quality of the final JPEG image from 0 to 100. A lower value can reduce the memory used by the image considerably which will result in faster and less intrusive uploads.
	*'''~~maxBandwith~~:''' The amount of client upload bandwidth to use (in bytes per second) when sending the image.		*'''maxBandwidth:''' The amount of client upload bandwidth to use (in bytes per second) when sending the image.
	*'''maxPacketSize: ''' The maximum size of one packet.		*'''maxPacketSize: ''' The maximum size of one packet.

Dragon: /* Example */ replaced current lackluster example with one that is a little more elaborate and practical

2023-01-24T03:33:23Z

Example: replaced current lackluster example with one that is a little more elaborate and practical

@@ Line 23: / Line 23: @@
 ==Example==
-This example will initiate a capture of a Random Players screen
+===Example 1===
 <syntaxhighlight lang="lua">
-local player = getRandomPlayer()
+local screenSizeX,screenSizeY = guiGetScreenSize() -- save the current screen dimensions
-takePlayerScreenShot( player, 320, 240 )
+local imgtexture
 </syntaxhighlight>
 ==Requirements==

Pirulax: added type of maxPacketSize

2019-01-04T00:04:15Z

added type of maxPacketSize

← Older revision		Revision as of 00:04, 4 January 2019
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwith = 5000, maxPacketSize = 500 ] )		bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwith = 5000, int maxPacketSize = 500 ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[player]]:takeScreenShot\|\|}}		{{OOP\|\|[[player]]:takeScreenShot\|\|}}

Pirulax: Added missing argument(maxPacketSize)

2019-01-04T00:03:58Z

Added missing argument(maxPacketSize)

← Older revision		Revision as of 00:03, 4 January 2019
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwith = 5000 ] )		bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwith = 5000, maxPacketSize = 500 ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[player]]:takeScreenShot\|\|}}		{{OOP\|\|[[player]]:takeScreenShot\|\|}}
Line 17:		Line 17:
	*'''quality:''' Quality of the final JPEG image from 0 to 100. A lower value can reduce the memory used by the image considerably which will result in faster and less intrusive uploads.		*'''quality:''' Quality of the final JPEG image from 0 to 100. A lower value can reduce the memory used by the image considerably which will result in faster and less intrusive uploads.
	*'''maxBandwith:''' The amount of client upload bandwidth to use (in bytes per second) when sending the image.		*'''maxBandwith:''' The amount of client upload bandwidth to use (in bytes per second) when sending the image.
			*'''maxPacketSize: ''' The maximum size of one packet.

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

Myonlake: /* Syntax */ consistency

2018-07-09T19:51:33Z

Syntax: consistency

← Older revision		Revision as of 19:51, 9 July 2018
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool takePlayerScreenShot( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwith = 5000 ] )		bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwith = 5000 ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[player]]:takeScreenShot\|\|}}		{{OOP\|\|[[player]]:takeScreenShot\|\|}}

← Older revision		Revision as of 22:45, 6 September 2024
Line 80:		Line 80:

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions\|server}}