Datafile::loadUgcFile: Difference between revisions

Latest revision as of 21:05, 6 May 2017

Loads a User-Generated Content (UGC) file. These files can be found in '[GTA5]/data/ugc' and '[GTA5]/common/patch/ugc'. They seem to follow a naming convention, most likely of '[name]_[part].ugc'. See example below for usage.

Returns whether or not the file was successfully loaded.

Example:
DATAFILE::_LOAD_UGC_FILE('RockstarPlaylists') // loads 'rockstarplaylists_00.ugc'

Syntax

mp.game.datafile.loadUgcFile(filename);

Required Arguments

filename: String

Return value

Boolean

Example

// todo

@@ Line 1: / Line 1: @@
 Loads a User-Generated Content (UGC) file. These files can be found in '[GTA5]/data/ugc' and '[GTA5]/common/patch/ugc'. They seem to follow a naming convention, most likely of '[name]_[part].ugc'. See example below for usage.<br><br>Returns whether or not the file was successfully loaded.<br><br>Example:<br>DATAFILE::_LOAD_UGC_FILE('RockstarPlaylists') // loads 'rockstarplaylists_00.ugc'
 ==Syntax==
-<syntaxhighlight lang="javascript">datafile.loadUgcFile(filename);</syntaxhighlight>
+<syntaxhighlight lang="javascript">mp.game.datafile.loadUgcFile(filename);</syntaxhighlight>
 === Required Arguments ===
 *'''filename:''' String
@@ Line 8: / Line 8: @@
 ==Example==
 <syntaxhighlight lang="javascript">
-todo
+// todo
 </syntaxhighlight>
 ==See also==
-{{Datafile_function_c}}
+{{Datafile_s_function_c}}
 [[Category:Clientside API]]
 [[Category:TODO: Example]]