GuiCreateStaticImage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(19 intermediate revisions by 14 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function creates a static image.
This function creates a static image using a .png image in the resource.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateStaticImage ( float x, float y, float width, float height, string filename, bool relative, element parent, [resource sourceResource = getThisResource()] )
element guiCreateStaticImage ( float x, float y, float width, float height, string path, [ bool relative = false, gui-element parent = nil] )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[Element/GUI/Static_image|GuiStaticImage]]}}
===Required Arguments===  
===Required Arguments===  
[[Image:gui-staticimage.png|frame|Example GUI static image.]]
*'''x:''' A float of the 2D x position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''x:''' A float of the 2D x position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the image. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the image. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the image. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the image. This is affected by the ''relative'' argument.
*'''filename:''' The location of the image file that is being loaded. This should be the same than the one specified in meta.xml file.
*'''path:''' The [[filepath]] of the image file that is being loaded.  
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.
*'''parent:''' This is the parent that the image is attached to. The ''relative'' argument must be true to use this. Sizes and positioning will be made relative to this parent. If ''nil'' parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.


===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''sourceResource:''' The resource to load the image from. Defaults to the resource that the script is running from.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.
*'''parent:''' This is the parent that the image is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.


===Returns===
===Returns===
Line 28: Line 28:
<section name="Client-side script (example.lua)" class="client" show="true">
<section name="Client-side script (example.lua)" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
[lua]
function showClientImage()
function showClientImage()
   guiCreateStaticImage( 20, 200, 100, 100, "imagename.png", false )
   guiCreateStaticImage( 20, 200, 100, 100, "imagename.png", false )
end
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), showClientImage )
addEventHandler( "onClientResourceStart", resourceRoot, showClientImage )
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>


<section name="meta.xml" class="server" show="true">
<section name="meta.xml" class="server" show="true">
In this example meta.xml is used to tell the server which files it will be using.
In this example [[Meta.xml]] is used to tell the server which files it will be using.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="xml">
  <info author="Yourname" version="1.0" />
<meta>
  <script src="example.lua" type="client" />
  <info author="Yourname" version="1.0" />
  <file src="imagename.png" />
  <script src="example.lua" type="client" />
  <file src="imagename.png" />
</meta>
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
Line 47: Line 48:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]
{{GUI_events}}

Latest revision as of 08:10, 30 October 2023

This function creates a static image using a .png image in the resource.

Syntax

element guiCreateStaticImage ( float x, float y, float width, float height, string path, [ bool relative = false, gui-element parent = nil] )

OOP Syntax Help! I don't understand this!

Method: GuiStaticImage(...)


Required Arguments

Example GUI static image.
  • x: A float of the 2D x position of the image on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the image on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the image. This is affected by the relative argument.
  • height: A float of the height of the image. This is affected by the relative argument.
  • path: The filepath of the image file that is being loaded.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.
  • parent: This is the parent that the image is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

Returns

Returns element if image was created successfully, false otherwise.

Example

This example will display an image (imagename.png) on the client's (player's) screen.

Click to collapse [-]
Client-side script (example.lua)
function showClientImage()
   guiCreateStaticImage( 20, 200, 100, 100, "imagename.png", false )
end
addEventHandler( "onClientResourceStart", resourceRoot, showClientImage )
Click to collapse [-]
meta.xml

In this example Meta.xml is used to tell the server which files it will be using. 

<meta>
  <info author="Yourname" version="1.0" />
  <script src="example.lua" type="client" />
  <file src="imagename.png" />
</meta>

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateStaticImage?oldid=78484"