htmlLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(mention of the config class in description)
m (Text replacement - "Killzone Kid" to "Killzone_Kid")
 
(61 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


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


| Load HTML from file to 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. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| control '''htmlLoad''' filename |= Syntax
|game4= tkoh
|version4= 1.00


|p1= control: [[Control]] |= Parameter 1
|game5= arma3
|version5= 0.50


|p2= filename: [[String]] |= Parameter 2
|gr1= GUI Control


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


|x1= <code>_control [[htmlLoad]] "briefing.html";</code> |= Example 1
|s1= control [[htmlLoad]] filename
|x2= <code>_control [[htmlLoad]] "<nowiki>http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English</nowiki>";//[http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English]</code> |= Example 2
|x3= Display news item:<code>0 = 0 [[spawn]] {
[[disableSerialization]];
_html = [[findDisplay]] 46 [[createDisplay]] "RscCredits" [[ctrlCreate]] ["RscHTML", -1];
_html [[ctrlSetBackgroundColor]] [0,0,0,0.8];
_html [[ctrlSetPosition]] <nowiki>[</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>|=
____________________________________________________________________________________________


|p1= control: [[Control]]


| [[ctrlHTMLLoaded]], [[loadFile]], [[preprocessFile]], [[preprocessFileLineNumbers]] |= See also
|p2= filename: [[String]] - local file name or remote file URL


}}
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_control htmlLoad "briefing.html";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


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


<h3 style="display:none">Bottom Section</h3>
|x3= Display news item:
[[Category:Scripting Commands|HTMLLOAD]]
<sqf>
[[Category:Scripting Commands ArmA|HTMLLOAD]]
[] spawn {
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
disableSerialization;
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
private _html = findDisplay 46 createDisplay "RscCredits" ctrlCreate ["RscHTML", -1];
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
_html ctrlSetBackgroundColor [0,0,0,0.8];
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
_html ctrlSetPosition [safeZoneX, safeZoneY, safeZoneW, safeZoneH];
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
_html ctrlCommit 0;
_html htmlLoad "http://www.bistudio.com/newsfeed/arma3_news.php?build=main&language=English";
};
</sqf>


<!-- CONTINUE Notes -->
|seealso= [[ctrlHTMLLoaded]] [[loadFile]] [[preprocessFile]] [[preprocessFileLineNumbers]] [[HTML File Format]]
<dl class="command_description">
}}
<dd class="notedate">Posted on September 7, 2014 - 18:02 (UTC)</dd>
<dt class="note">[[User:BrotherhoodOfHam|BrotherhoodOfHam]]</dt>
<dd class="note">
<br/>htmlLoad works with URL's as well as html files.
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= BrotherhoodOfHam
<dd class="notedate">Posted on September 7, 2014 - 19:35 (UTC)</dd>
|timestamp= 20140907180200
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|text= [[htmlLoad]] works with URLs as well as html files.
<dd class="note">
}}
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.
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Killzone_Kid
<dd class="notedate">Posted on April 21, 2015 - 18:08 (UTC)</dd>
|timestamp= 20140907193500
<dt class="note">[[User:Benargee|Benargee]]</dt>
|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 class="note">Example use of URL can be found in [[BIS_fnc_GUInewsfeed]] with the function browser.
It is therefore not recommended to use this command in such way.
</dd>
}}
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Benargee
<dd class="notedate">Posted on October 7, 2015 - 22:03 (UTC)</dd>
|timestamp= 20150421180800
<dt class="note">[[User:Tupolov|Tupolov]]</dt>
|text= Example use of URL can be found in [[BIS_fnc_GUInewsfeed]] with the function browser.
<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>
{{Note
'''Script Example''':
|user= Tupolov
<code>_newsOnline = <nowiki>"http://alivemod.com/alive_news.php?map=" + _map + "&mission=" + _mission + "&player=" + _player;</nowiki>
|timestamp= 20151007220300
_ctrlHTML htmlLoad _newsOnline;</code>
|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:
'''Config Example:'''<br>
'''Script'''
<code>class CfgCommands {
<sqf>
  allowedHTMLLoadURIs[] += {
_newsOnline = "http://alivemod.com/alive_news.php?map=" + _map + "&amp;mission=" + _mission + "&amp;player=" + _player;
      <nowiki>"http://alivemod.com/alive_news.php*"</nowiki>
_ctrlHTML htmlLoad _newsOnline;
  };
</sqf>
};</code>
'''Config'''
</dd>
<syntaxhighlight lang="cpp">
</dl>
class CfgCommands {
<!-- DISCONTINUE Notes -->
allowedHTMLLoadURIs[] += {
"http://alivemod.com/alive_news.php*"
};
};
</syntaxhighlight>
|game= arma3
}}

Latest revision as of 14:48, 12 March 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:
[] 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=353089"