DgsMediaClearMedia: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function clears the media in the (dgsCreateMediaBrowser) element. ==Syntax== <syntaxhighlight lang="lua"> string dgsMediaGetMediaPath...")
 
No edit summary
 
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string dgsMediaGetMediaPath ( element media )
bool dgsMediaClearMedia ( element media )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===
===Required Arguments===
*'''media:''' The element media that you want it's file path.
*'''media:''' The media element that you want cleared.


===Returns===
===Returns===
Returns file path of the loaded media of media browser element, false if there's no media.
Returns true if success, false otherwise.


==Example==  
==Example==  

Latest revision as of 19:42, 17 August 2018

This function clears the media in the (dgsCreateMediaBrowser) element.

Syntax

bool dgsMediaClearMedia ( element media )

Required Arguments

  • media: The media element that you want cleared.

Returns

Returns true if success, false otherwise.

Example

This example loads a local gif image and outputs the file path to chatBox. 

loadstring(exports.dgs:dgsImportFunction())()  --Import DGS functions

browser = dgsCreateMediaBrowser(256,256) --Create Multi Media Browser
dgsMediaLoadMedia(browser,"test.gif","IMAGE")  --Load the gif file into multi media browser
image = dgsCreateImage(200,200,200,200,browser,false)  --Apply the browser to a dgs-dximage

if dgsMediaClearMedia(browser) then
    outputChatBox("Media element cleared.")
else
    outputChatBox("Something went wrong.")
end

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsMediaClearMedia?oldid=58400"