Astrath:createImage - Revision history

Sybellex at 20:10, 22 October 2025

2025-10-22T20:10:33Z

← Older revision		Revision as of 20:10, 22 October 2025
Line 5:		Line 5:

	'''Description:'''		'''Description:'''
	Creates a new DX-based image element. Images can be attached to parent elements, support transparency, ~~and~~ custom styles. Each image instance is automatically registered in the DX library.		Creates a new DX-based image element. Images can be attached to parent elements, support transparency, custom styles, and optional parent-relative positioning. Each image instance is automatically registered in the DX library.

	'''Parameters:'''		'''Parameters:'''
			* path (string) – Path to the image file. Must exist.
	path (string) – Path to the image file. Must exist.		* posX, posY (float) – Position on screen.
			* width, height (float) – Size of the image.
	posX, posY (float) – Position on screen.		* parent (element) – Parent DX element to attach this image to (optional).
			* relative (boolean) – Position relative to parent (optional).
	width, height (float) – Size of the image.

	parent (element) – Parent DX element to attach this image to (optional).

	relative (boolean) – Position relative to parent (optional).

	'''Returns:'''		'''Returns:'''
Line 24:		Line 19:
	'''Methods:'''		'''Methods:'''
	{\| class="wikitable" style="width:100%; border:none;"		{\| class="wikitable" style="width:100%; border:none;"

	! Method !! Description		! Method !! Description
	Ath:destroy()		\|-
	-		\| Ath:destroy() \|\| Destroys the image element and all its child elements.
	Ath:setVisible(boolean)		\|-
	-		\| Ath:setVisible(boolean) \|\| Shows or hides the image.
	Ath:setEnabled(boolean)		\|-
	-		\| Ath:setEnabled(boolean) \|\| Enables or disables the image for interaction.
	Ath:setAlpha(~~int)~~		\|-
	-		\| Ath:setAlpha(number) \|\| Sets the image transparency (0–255).
	~~Ath:setPath(string~~)		\|}
	-
	~~Ath:draw~~()
	}

	'''Example:'''		'''Example:'''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- Create an image at position 100x100 with size 200x150~~
	local myImage = DxImage:new("images/logo.png", 100, 100, 200, 150)		local myImage = DxImage:new("images/logo.png", 100, 100, 200, 150)

	~~-- Show the image and set transparency~~
	myImage:setVisible(true)		myImage:setVisible(true)
	myImage:setAlpha(200)		myImage:setAlpha(200)

	~~-- Change the image path~~
	myImage:setPath("images/new_logo.png")		myImage:setPath("images/new_logo.png")

	~~-- Draw the image~~
	myImage:draw()		myImage:draw()
	</syntaxhighlight>		</syntaxhighlight>

	'''See also:'''		'''See also:'''
			* [[Astrath]] – Main library page
	[[Astrath]] – Main library page		* [[DxWindow:new]] – Page for window element reference
			* [[DxLabel:new]] – Page for label element reference
	[[DxWindow:new]] – Page for window element reference		* [[onClientRender]] – Event used to render DX elements

	[[DxLabel:new]] – Page for label element reference

	[[onClientRender]] – Event used to render DX elements

Sybellex at 20:03, 22 October 2025

2025-10-22T20:03:15Z

← Older revision		Revision as of 20:03, 22 October 2025
Line 1:		Line 1:
	== DxImage:new ==		= DxImage:new =

			{{Client function}}
			{{FuncDef\|element DxImage:new ( string path, float posX, float posY, float width, float height, element parent, boolean relative )}}

	'''Description:'''		'''Description:'''
	Creates a new ~~DxImage~~ element, ~~which displays a static~~ image on ~~the~~ screen. ~~Uses table-based syntax with metatable~~.		Creates a new DX-based image element. Images can be attached to parent elements, support transparency, and custom styles. Each image instance is automatically registered in the DX library.

			'''Parameters:'''

			path (string) – Path to the image file. Must exist.

			posX, posY (float) – Position on screen.

			width, height (float) – Size of the image.

	~~'''Syntax:'''~~		parent (element) – Parent DX element to attach this image to (optional).
	~~<pre>~~
	~~local~~ image ~~= DxImage:new~~(~~path, posX, posY, width, height, parent, relative~~)
	~~</pre>~~

	~~'''Parameters:'''~~		relative (boolean) – Position relative to parent (optional).
	~~<pre>~~
	~~path - string - Path to the image file~~ (~~must exist~~)
	~~posX - float - X position on screen~~
	~~posY - float - Y position on screen~~
	~~width - float - Width of the image~~
	~~height - float - Height of the image~~
	parent ~~- element~~ (optional) ~~- Parent DX element~~
	~~relative - boolean (optional) - Whether position is relative to parent~~
	~~</pre>~~

	'''~~Return Value~~:'''		'''Returns:'''
	~~<pre>~~		: Returns the newly created DxImage element.
	~~element - table - The~~ newly created DxImage element
	~~</pre>~~

	'''Methods:'''		'''Methods:'''
	~~<pre>~~		{\| class="wikitable" style="width:100%; border:none;"
	~~image~~:destroy() - ~~Destroys the element and all its children~~
	~~image~~:setVisible(boolean) - ~~Sets the visibility~~		! Method !! Description
	~~image~~:setEnabled(boolean) - ~~Enables or disables the element~~		Ath:destroy()
	~~image~~:setAlpha(int) - ~~Sets transparency (0–255)~~		-
	~~image~~:setPath(string) - ~~Changes the image file path (must exist)~~		Ath:setVisible(boolean)
	~~image~~:draw() ~~- Draws the image using its defined style~~		-
	~~</pre>~~		Ath:setEnabled(boolean)
			-
			Ath:setAlpha(int)
			-
			Ath:setPath(string)
			-
			Ath:draw()
			}

	'''Example:'''		'''Example:'''
	<~~pre~~>		<syntaxhighlight lang="lua">
	local ~~img~~ = DxImage:new("images/logo.png", 100, 100, 200, 150)		-- Create an image at position 100x100 with size 200x150
	~~img~~:~~setAlpha~~(~~200~~)		local myImage = DxImage:new("images/logo.png", 100, 100, 200, 150)
	~~img~~:~~setVisible~~(~~true~~)
	~~img~~:setPath("images/new_logo.png")		-- Show the image and set transparency
	~~img~~:draw()		myImage:setVisible(true)
	</~~pre~~>		myImage:setAlpha(200)

			-- Change the image path
			myImage:setPath("images/new_logo.png")

			-- Draw the image
			myImage:draw()
			</syntaxhighlight>

			'''See also:'''

			[[Astrath]] – Main library page

			[[DxWindow:new]] – Page for window element reference

			[[DxLabel:new]] – Page for label element reference

	~~'''See Also:'''~~		[[onClientRender]] – Event used to render DX elements
	~~DxWindow:new, DxLabel:new, DxButton:new~~

Sybellex at 20:01, 22 October 2025

2025-10-22T20:01:56Z

← Older revision		Revision as of 20:01, 22 October 2025
Line 1:		Line 1:
	= DxImage:new =		== DxImage:new ==
			'''Description:'''
	~~{{Client function}} {{FuncDef\|element~~ DxImage~~:new ( string path, float posX, float posY, float width, float height,~~ element ~~parent~~, ~~boolean relative )}}~~		Creates a new DxImage element, which displays a static image on the screen. Uses table-based syntax with metatable.

	'''~~Description~~:'''		'''Syntax:'''
	~~Creates a DX~~ image ~~element. An image element displays a static image from a file on the screen.~~		<pre>
			local image = DxImage:new(path, posX, posY, width, height, parent, relative)
			</pre>

	'''Parameters:'''		'''Parameters:'''
			<pre>
			path - string - Path to the image file (must exist)
			posX - float - X position on screen
			posY - float - Y position on screen
			width - float - Width of the image
			height - float - Height of the image
			parent - element (optional) - Parent DX element
			relative - boolean (optional) - Whether position is relative to parent
			</pre>

	~~path (string) – Path to the image file (must exist).~~		'''Return Value:'''
			<pre>
	~~posX, posY (float) – Position on screen.~~		element - table - The newly created DxImage element
			</pre>
	~~width, height (float) – Size of the image.~~

	~~parent (element) – Parent DX element (optional).~~

	~~relative (boolean) – Position relative to parent (optional).~~

	'''~~Returns~~:'''
	~~: Returns the~~ newly created DxImage element.

	'''Methods:'''		'''Methods:'''
	~~{\| class="wikitable" style="width~~:~~100%; border:none;"~~		<pre>
			image:destroy() - Destroys the element and all its children
	~~! Method !! Description~~		image:setVisible(boolean) - Sets the visibility
	~~Ath~~:setVisible(boolean)		image:setEnabled(boolean) - Enables or disables the element
	-		image:setAlpha(int) - Sets transparency (0–255)
	~~Ath~~:setEnabled(boolean)		image:setPath(string) - Changes the image file path (must exist)
	-		image:draw() - Draws the image using its defined style
	~~Ath~~:setAlpha(int)		</pre>
	-
	~~Ath~~:setPath(string path)
	-
	~~Ath~~:~~destroy~~()
	}

	'''Example:'''		'''Example:'''
	<~~syntaxhighlight lang="lua"~~>		<pre>
	local img = DxImage:new("images/logo.png", 100, 100, 200, 150)		local img = DxImage:new("images/logo.png", 100, 100, 200, 150)
	img:setAlpha(200)		img:setAlpha(200)
	img:setVisible(true)		img:setVisible(true)
	</~~syntaxhighlight~~>		img:setPath("images/new_logo.png")
			img:draw()
			</pre>

			'''See Also:'''
			DxWindow:new, DxLabel:new, DxButton:new

Sybellex: Created page with "= DxImage:new = {{Client function}} {{FuncDef|element DxImage:new ( string path, float posX, float posY, float width, float height, element parent, boolean relative )}} '''Description:''' Creates a DX image element. An image element displays a static image from a file on the screen. '''Parameters:''' path (string) – Path to the image file (must exist). posX, posY (float) – Position on screen. width, height (float) – Size of the image. parent (element) – P..."

2025-10-22T19:59:06Z

Created page with "= DxImage:new = {{Client function}} {{FuncDef|element DxImage:new ( string path, float posX, float posY, float width, float height, element parent, boolean relative )}} '''Description:''' Creates a DX image element. An image element displays a static image from a file on the screen. '''Parameters:''' path (string) – Path to the image file (must exist). posX, posY (float) – Position on screen. width, height (float) – Size of the image. parent (element) – P..."

New page

= DxImage:new =

{{Client function}} {{FuncDef|element DxImage:new ( string path, float posX, float posY, float width, float height, element parent, boolean relative )}}

'''Description:'''
Creates a DX image element. An image element displays a static image from a file on the screen.

'''Parameters:'''

path (string) – Path to the image file (must exist).

posX, posY (float) – Position on screen.

width, height (float) – Size of the image.

parent (element) – Parent DX element (optional).

relative (boolean) – Position relative to parent (optional).

'''Returns:'''
: Returns the newly created DxImage element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"

! Method !! Description
Ath:setVisible(boolean)
-
Ath:setEnabled(boolean)
-
Ath:setAlpha(int)
-
Ath:setPath(string path)
-
Ath:destroy()
}

'''Example:'''
<syntaxhighlight lang="lua">
local img = DxImage:new("images/logo.png", 100, 100, 200, 150)
img:setAlpha(200)
img:setVisible(true)
</syntaxhighlight>