htmlLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
 
m (Text replacement - "[] spawn" to "0 spawn")
 
(90 intermediate revisions by 17 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|HTMLLOAD]]
{{RV|type=command
[[Category:Scripting Commands ArmA|HTMLLOAD]]


|game1= arma1
|version1= 1.00


<h2 style="color:#000066">''control '' ''' htmlLoad '' filename'''''</h2>
|game2= arma2
|version2= 1.00


|game3= arma2oa
|version3= 1.50


'''Operand types:'''
|game4= tkoh
|version4= 1.00


'''control''': [[Control]]
|game5= arma3
|version5= 0.50


'''filename:''' [[String]]
|gr1= GUI Control


'''Type of returned value:'''
|descr= Load [[HTML File Format|HTML]] from file or URI using given control. File path is relative to current mission dir or an absolute path (with drive letter etc.).
The command is subject to restrictions, imposed by [[CfgCommands]] class.
{{Feature|arma3|Since {{GVI|arma3|2.10|size= 0.75}} the 'title' attribute is supported within &lt;img&gt; and &lt;a&gt; html tags}}
{{Feature|important|For unknown reasons, URL's length is limited to 255 characters.}}


[[Nothing]]
|s1= control [[htmlLoad]] filename


'''Compatibility:'''
|p1= control: [[Control]]


Version 2.53 required.
|p2= filename: [[String]] - local file name or remote file URL


'''Description:'''
|r1= [[Nothing]]


Load HTML from file to given control.  
|x1= <sqf>_control htmlLoad "briefing.html";</sqf>


|x2= <sqf>_control htmlLoad "http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English";</sqf>


'''Example'''
|x3= Display news item:
<sqf>
0 spawn {
disableSerialization;
private _html = findDisplay 46 createDisplay "RscCredits" ctrlCreate ["RscHTML", -1];
_html ctrlSetBackgroundColor [0,0,0,0.8];
_html ctrlSetPosition [safeZoneX, safeZoneY, safeZoneW, safeZoneH];
_html ctrlCommit 0;
_html htmlLoad "http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English";
};
</sqf>


_control '''htmlLoad''' "briefing.html"
|seealso= [[ctrlHTMLLoaded]] [[loadFile]] [[preprocessFile]] [[preprocessFileLineNumbers]] [[HTML File Format]]
}}
 
{{Note
|user= BrotherhoodOfHam
|timestamp= 20140907180200
|text= [[htmlLoad]] works with URLs as well as html files.
}}
 
{{Note
|user= Killzone_Kid
|timestamp= 20140907193500
|text= While [[htmlLoad]] surprisingly does work with URLs as pointed above, the operation is blocking, meaning the whole game will freeze until the operation is complete.
It is therefore not recommended to use this command in such way.
}}
 
{{Note
|user= Benargee
|timestamp= 20150421180800
|text= Example use of URL can be found in [[BIS_fnc_GUInewsfeed]] with the function browser.
}}
 
{{Note
|user= Tupolov
|timestamp= 20151007220300
|text= ({{arma3}}) In order to use URLs, they must be included in CfgCommands -> allowedHTMLLoadURIs. In order to use URIs with params a wildcard * character is supported:
'''Script'''
<sqf>
_newsOnline = "http://alivemod.com/alive_news.php?map=" + _map + "&amp;mission=" + _mission + "&amp;player=" + _player;
_ctrlHTML htmlLoad _newsOnline;
</sqf>
'''Config'''
<syntaxhighlight lang="cpp">
class CfgCommands {
allowedHTMLLoadURIs[] += {
"http://alivemod.com/alive_news.php*"
};
};
</syntaxhighlight>
|game= arma3
}}

Latest revision as of 21:24, 2 September 2024

Hover & click on the images for description

Description

Description:
Load HTML from file or URI using given control. File path is relative to current mission dir or an absolute path (with drive letter etc.). The command is subject to restrictions, imposed by CfgCommands class.
Arma 3
Since Arma 3 logo black.png2.10 the 'title' attribute is supported within <img> and <a> html tags
For unknown reasons, URL's length is limited to 255 characters.
Groups:
GUI Control

Syntax

Syntax:
control htmlLoad filename
Parameters:
control: Control
filename: String - local file name or remote file URL
Return Value:
Nothing

Examples

Example 1:
_control htmlLoad "briefing.html";
Example 2:
_control htmlLoad "http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English";
Example 3:
Display news item:
0 spawn { disableSerialization; private _html = findDisplay 46 createDisplay "RscCredits" ctrlCreate ["RscHTML", -1]; _html ctrlSetBackgroundColor [0,0,0,0.8]; _html ctrlSetPosition [safeZoneX, safeZoneY, safeZoneW, safeZoneH]; _html ctrlCommit 0; _html htmlLoad "http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English"; };

Additional Information

See also:
ctrlHTMLLoaded loadFile preprocessFile preprocessFileLineNumbers HTML File Format

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
BrotherhoodOfHam - c
Posted on Sep 07, 2014 - 18:02 (UTC)
htmlLoad works with URLs as well as html files.
Killzone_Kid - c
Posted on Sep 07, 2014 - 19:35 (UTC)
While htmlLoad surprisingly does work with URLs as pointed above, the operation is blocking, meaning the whole game will freeze until the operation is complete. It is therefore not recommended to use this command in such way.
Benargee - c
Posted on Apr 21, 2015 - 18:08 (UTC)
Example use of URL can be found in BIS_fnc_GUInewsfeed with the function browser.
Tupolov - c
Posted on Oct 07, 2015 - 22:03 (UTC)

(Arma 3) In order to use URLs, they must be included in CfgCommands -> allowedHTMLLoadURIs. In order to use URIs with params a wildcard * character is supported: Script

_newsOnline = "http://alivemod.com/alive_news.php?map=" + _map + "&amp;mission=" + _mission + "&amp;player=" + _player; _ctrlHTML htmlLoad _newsOnline;
Config

class CfgCommands {
	allowedHTMLLoadURIs[] += {
		"http://alivemod.com/alive_news.php*"
	};
};