htmlLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - "[] spawn" to "0 spawn")
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|version2= 1.00


|gr1= GUI Control |GROUP1=
|game3= arma2oa
|version3= 1.50


| 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.
|game4= tkoh
{{Warning | For unknown reasons, URL's length is limited to 255 characters.}} |DESCRIPTION=
|version4= 1.00


| control [[htmlLoad]] filename |SYNTAX=
|game5= arma3
|version5= 0.50


|p1= control: [[Control]] |PARAMETER1=
|gr1= GUI Control


|p2= filename: [[String]] - local file name or remote file URL |PARAMETER2=
|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 <img> and <a> html tags}}
{{Feature|important|For unknown reasons, URL's length is limited to 255 characters.}}


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


|x1= <code>_control [[htmlLoad]] "briefing.html";</code> |EXAMPLE1=
|p1= control: [[Control]]


|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> |EXAMPLE2=
|p2= filename: [[String]] - local file name or remote file URL


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


| [[ctrlHTMLLoaded]], [[loadFile]], [[preprocessFile]], [[preprocessFileLineNumbers]], [[HTML File Format]] |SEEALSO=
|x1= <sqf>_control htmlLoad "briefing.html";</sqf>
}}


<h3 style="display:none">Notes</h3>
|x2= <sqf>_control htmlLoad "http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x3= Display news item:
</dl>
<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>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[ctrlHTMLLoaded]] [[loadFile]] [[preprocessFile]] [[preprocessFileLineNumbers]] [[HTML File Format]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= BrotherhoodOfHam
<dd class="notedate">Posted on September 7, 2014 - 18:02 (UTC)</dd>
|timestamp= 20140907180200
<dt class="note">[[User:BrotherhoodOfHam|BrotherhoodOfHam]]</dt>
|text= [[htmlLoad]] works with URLs as well as html files.
<dd class="note">
}}
<br>htmlLoad works with URL's as well as html files.
</dd>


<dd class="notedate">Posted on September 7, 2014 - 19:35 (UTC)</dd>
{{Note
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|user= Killzone_Kid
<dd class="note">
|timestamp= 20140907193500
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.
|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.
</dd>
It is therefore not recommended to use this command in such way.
}}


<dd class="notedate">Posted on April 21, 2015 - 18:08 (UTC)</dd>
{{Note
<dt class="note">[[User:Benargee|Benargee]]</dt>
|user= Benargee
<dd class="note">Example use of URL can be found in [[BIS_fnc_GUInewsfeed]] with the function browser.
|timestamp= 20150421180800
</dd>
|text= Example use of URL can be found in [[BIS_fnc_GUInewsfeed]] with the function browser.
}}


<dd class="notedate">Posted on October 7, 2015 - 22:03 (UTC)</dd>
{{Note
<dt class="note">[[User:Tupolov|Tupolov]]</dt>
|user= Tupolov
<dd class="note">
|timestamp= 20151007220300
(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>
|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 Example''':
'''Script'''
<code>_newsOnline = <nowiki>"http://alivemod.com/alive_news.php?map=" + _map + "&mission=" + _mission + "&player=" + _player;</nowiki>
<sqf>
_ctrlHTML htmlLoad _newsOnline;</code>
_newsOnline = "http://alivemod.com/alive_news.php?map=" + _map + "&amp;mission=" + _mission + "&amp;player=" + _player;
'''Config Example:'''<br>
_ctrlHTML htmlLoad _newsOnline;
</sqf>
'''Config'''
<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>
};
</dd>
</syntaxhighlight>
</dl>
|game= arma3
<!-- DISCONTINUE Notes -->
}}

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"