htmlLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory *\| *arma1 *\| *(New )?Scripting Commands\}\}" to "")
m (Text replacement - "[] spawn" to "0 spawn")
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|1.00
|version1= 1.00


|game2= arma2
|game2= arma2
Line 18: Line 18:
|gr1= GUI Control
|gr1= GUI Control


| 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.
|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.).
{{Feature | Warning | For unknown reasons, URL's length is limited to 255 characters.}}
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 <img> and <a> html tags}}
{{Feature|important|For unknown reasons, URL's length is limited to 255 characters.}}


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


|p1= control: [[Control]]
|p1= control: [[Control]]
Line 29: Line 31:
|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>_control [[htmlLoad]] "briefing.html";</code>
|x1= <sqf>_control htmlLoad "briefing.html";</sqf>


|x2= <code>_control [[htmlLoad]] "<nowiki>http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English</nowiki>"; {{cc|[http://www.bistudio.com/newsfeed/arma3_news.php?build{{=}}main&language{{=}}English link]}}</code>
|x2= <sqf>_control htmlLoad "http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English";</sqf>


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


|seealso= [[ctrlHTMLLoaded]], [[loadFile]], [[preprocessFile]], [[preprocessFileLineNumbers]], [[HTML File Format]]
|seealso= [[ctrlHTMLLoaded]] [[loadFile]] [[preprocessFile]] [[preprocessFileLineNumbers]] [[HTML File Format]]
}}
}}


{{GameCategory|arma2|Scripting Commands}}
{{Note
{{GameCategory|arma3|Scripting Commands}}
|user= BrotherhoodOfHam
{{GameCategory|tkoh|Scripting Commands}}
|timestamp= 20140907180200
|text= [[htmlLoad]] works with URLs as well as html files.
}}


<dl class="command_description">
{{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.
}}


<dt></dt>
{{Note
<dd class="notedate">Posted on September 7, 2014 - 18:02 (UTC)</dd>
|user= Benargee
<dt class="note">[[User:BrotherhoodOfHam|BrotherhoodOfHam]]</dt>
|timestamp= 20150421180800
<dd class="note">
|text= Example use of URL can be found in [[BIS_fnc_GUInewsfeed]] with the function browser.
<br>htmlLoad works with URL's as well as html files.
}}
</dd>


<dt><dt>
{{Note
<dd class="notedate">Posted on September 7, 2014 - 19:35 (UTC)</dd>
|user= Tupolov
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|timestamp= 20151007220300
<dd class="note">
|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:
While surprisingly [[htmlLoad]] does work with URLs as pointed above, the operation is blocking, meaning the whole game will freeze until the operation is complete. Therefore it is not recommended to use this command in such way.
'''Script'''
</dd>
<sqf>
 
_newsOnline = "http://alivemod.com/alive_news.php?map=" + _map + "&amp;mission=" + _mission + "&amp;player=" + _player;
<dt><dt>
_ctrlHTML htmlLoad _newsOnline;
<dd class="notedate">Posted on April 21, 2015 - 18:08 (UTC)</dd>
</sqf>
<dt class="note">[[User:Benargee|Benargee]]</dt>
'''Config'''
<dd class="note">Example use of URL can be found in [[BIS_fnc_GUInewsfeed]] with the function browser.
</dd>
 
<dt><dt>
<dd class="notedate">Posted on October 7, 2015 - 22:03 (UTC)</dd>
<dt class="note">[[User:Tupolov|Tupolov]]</dt>
<dd class="note">
(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:<br><br>
'''Script Example''':
<code>_newsOnline = <nowiki>"http://alivemod.com/alive_news.php?map=" + _map + "&mission=" + _mission + "&player=" + _player;</nowiki>
_ctrlHTML htmlLoad _newsOnline;</code>
'''Config Example:'''<br>
<syntaxhighlight lang="cpp">
<syntaxhighlight lang="cpp">
class CfgCommands {
class CfgCommands {
  allowedHTMLLoadURIs[] += {
allowedHTMLLoadURIs[] += {
      "http://alivemod.com/alive_news.php*"
"http://alivemod.com/alive_news.php*"
  };
};
};
};
</syntaxhighlight>
</syntaxhighlight>
</dd>
|game= arma3
</dl>
}}

Latest revision as of 21:24, 2 September 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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 logo black.png1.00

(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*"
	};
};
Retrieved from "https://community.bistudio.com/wiki?title=htmlLoad&oldid=369066"