Child pages
  • agent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{hiddendiv:style=display:none}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACTAUTO CHANGES FROMUPDATE THE PAGECONTENT ANDTHROUGH MERGETHE THEM BACK INTO SERVOY SOURCE{hiddenDOC GENERATOR{div}
{sub-sectiondiv:id=description|text=}{sub-sectiondiv}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#x]
Gets or sets the x position of the agent.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#y]
Gets or sets the y position of the agent.{td}{tr}{tbody}{table}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}void{td}{td}[#setBalloonSize]\(width, height)
Sets the size of the balloon.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setImageURL]\(url)
Sets a new image for the agent.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setLocation]\(x, y)
Sets the location of the agent.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setVisible]\(visible)
Show/hides the agent.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#speak]\(message)
Makes the agent speak.{td}{tr}{tbody}{table}\\ 

{table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=x|class=node}{tr:id=name}{td}h6.x{td}{tr}{builder-showtr:permission=edit}{tr:id=desid=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{sub-section:x_des|trigger=button|text=}{sub-section}{sub-section:x_des|trigger=none|tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:x_snc|trigger=button|text=}{sub-section}{sub-section:x_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:x_prs|trigger=button|text=}{sub-section}{sub-section:x_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:x_ret|trigger=button|text=}{sub-section}{sub-section:x_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:x_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:x_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:x_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:x_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:x_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:x_sam|trigger=none}{code:language=javascript}
//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=y|class=node}{tr:id=name}{td}h6.y{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:y_des|trigger=button|text=}{sub-section}{sub-section:y_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:y_snc|trigger=button|text=}{sub-section}{sub-section:y_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:y_prs|trigger=button|text=}{sub-section}{sub-section:y_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:y_ret|trigger=button|text=}{sub-section}{sub-section:y_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:y_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:y_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:y_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:y_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:y_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:y_sam|trigger=none}{code:language=javascript}
//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ 

{table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=setBalloonSize-Number_Number|class=node}{tr:id=name}{td}h6.setBalloonSize{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setBalloonSize{span}{span:id=iets|style=float: left;}\(width, height){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:setBalloonSize-Number_Number_des|trigger=button|text=}{sub-section}{sub-section:setBalloonSize-Number_Number_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setBalloonSize-Number_Number_snc|trigger=button|text=}{sub-section}{sub-section:setBalloonSize-Number_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setBalloonSize-Number_Number_prs|trigger=button|text=}{sub-section}{sub-section:setBalloonSize-Number_Number_prs|trigger=none|class=sIndent}\{[Number]} width
\{[Number]} height
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setBalloonSize-Number_Number_ret|trigger=button|text=}{sub-section}{sub-section:setBalloonSize-Number_Number_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setBalloonSize-Number_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setBalloonSize-Number_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setBalloonSize-Number_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setBalloonSize-Number_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setBalloonSize-Number_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setBalloonSize-Number_Number_sam|trigger=none}{code:language=javascript}
plugins.agent.setBalloonSize(width,height)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setImageURL-String|class=node}{tr:id=name}{td}h6.setImageURL{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setImageURL{span}{span:id=iets|style=float: left;}\(url){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:setImageURL-String_des|trigger=button|text=}{sub-section}{sub-section:setImageURL-String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setImageURL-String_snc|trigger=button|text=}{sub-section}{sub-section:setImageURL-String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setImageURL-String_prs|trigger=button|text=}{sub-section}{sub-section:setImageURL-String_prs|trigger=none|class=sIndent}\{[String]} url
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setImageURL-String_ret|trigger=button|text=}{sub-section}{sub-section:setImageURL-String_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setImageURL-String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setImageURL-String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setImageURL-String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setImageURL-String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setImageURL-String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setImageURL-String_sam|trigger=none}{code:language=javascript}
plugins.agent.setImageURL("url")
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setLocation-Number_Number|class=node}{tr:id=name}{td}h6.setLocation{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setLocation{span}{span:id=iets|style=float: left;}\(x, y){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:setLocation-Number_Number_des|trigger=button|text=}{sub-section}{sub-section:setLocation-Number_Number_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setLocation-Number_Number_snc|trigger=button|text=}{sub-section}{sub-section:setLocation-Number_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setLocation-Number_Number_prs|trigger=button|text=}{sub-section}{sub-section:setLocation-Number_Number_prs|trigger=none|class=sIndent}\{[Number]} x
\{[Number]} y
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setLocation-Number_Number_ret|trigger=button|text=}{sub-section}{sub-section:setLocation-Number_Number_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setLocation-Number_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocation-Number_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setLocation-Number_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocation-Number_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setLocation-Number_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocation-Number_Number_sam|trigger=none}{code:language=javascript}
plugins.agent.setLocation(100,100);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setVisible-Boolean|class=node}{tr:id=name}{td}h6.setVisible{code:language=javascript}
//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=y}{tr:id=name}{td}h6.y{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ 

{table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=setBalloonSize-Number_Number}{tr:id=name}{td}h6.setBalloonSize{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setBalloonSize{span}{span}\(width, height){span}{td}{tr}{tr:id=sigprs}{td}*Parameters*\\{spandiv:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setVisible{span}{span:id=iets|style=float: left;}\(visible){spanclass=sIndent}\{[Number]} width
\{[Number]} height
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{builder-show:permission=edit}{tr:id=dessam}{td}*Sample*\\{div:class=sIndent}{sub-section:setVisible-Boolean_des|trigger=button|text=}{sub-section}{sub-section:setVisible-Boolean_des|trigger=none|class=sIndent}Replace with description{sub-sectioncode:language=javascript}
plugins.agent.setBalloonSize(width,height)
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{builder-showtbody:id=setImageURL-String}{builder-show:permission=edittr:id=name}{td}h6.setImageURL{td}{tr}{tr:id=sncsig}{td}*Since*\\{sub-section:setVisible-Boolean_snc|trigger=button|text=}{sub-section}{sub-section:setVisible-Boolean_snc|trigger=none|class=sIndent} Replace with version info{sub-section{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setImageURL{span}{span}\(url){span}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setVisible-Boolean_prs|trigger=button|text=}{sub-section}{sub-section:setVisible-Boolean_prs|trigger=none|{div:class=sIndent}\{[BooleanString]} visibleurl
{sub-sectiondiv}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setVisible-Boolean_ret|trigger=button|text=}{sub-section}{sub-section:setVisible-Boolean_ret|trigger=none|div:class=sIndent}void{sub-sectiondiv}{td}{tr}{builder-show:permission=edittr}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:setVisible-Boolean_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setVisible-Boolean_see|trigger=none}{sub-section}{divdiv:class=sIndent}{code:language=javascript}
plugins.agent.setImageURL("url")
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{builder-showtbody}{builder-showtbody:permission=editid=setLocation-Number_Number}{tr:id=link}name}{td}h6.setLocation{td}*External links*\\{sub-section:setVisible-Boolean_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setVisible-Boolean_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setLocation{span}{span}\(x, y){span}{td}{tr}{tr:id=samprs}{td}*SampleParameters*\\{sub-section:setVisible-Boolean_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setVisible-Boolean_sam|trigger=none}{code:language=javascript}
plugins.agent.setVisible(true);
{code}{sub-section}\{[Number]} x
\{[Number]} y
{div}{td}{tr}{tr:classid=lastDetailRowret}{td}{td}{tr}{tbody}{tbody:id=speak-String|class=node*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=namesam}{td}h6.speak{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}speak{span}{span:id=iets|style=float: left;}\(message){span*Sample*\\{div:class=sIndent}{code:language=javascript}
plugins.agent.setLocation(100,100);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{builder-showtbody:permissionid=editsetVisible-Boolean}{tr:id=des}name}{td}h6.setVisible{td}{tr}{sub-section:speak-String_des|trigger=button|text=}{sub-section}{sub-section:speak-String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edittr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setVisible{span}{span}\(visible){span}{td}{tr}{tr:id=sncprs}{td}*SinceParameters*\\{sub-section:speak-String_snc|trigger=button|text=}{sub-section}{sub-section:speak-String_snc|trigger=none|class=sIndent} Replace with version info{sub-sectiondiv:class=sIndent}\{[Boolean]} visible
{div}{td}{tr}{builder-show}{tr:id=prsret}{td}*ParametersReturns*\\{sub-section:speak-String_prs|trigger=button|text=}{sub-section}{sub-section:speak-String_prs|trigger=none|div:class=sIndent}\{[String]} message
{sub-sectionvoid{div}{td}{tr}{tr:id=retsam}{td}*ReturnsSample*\\{sub-section:speak-String_ret|trigger=button|text=}{sub-section}{sub-section:speak-String_ret|trigger=none|class=sIndent}void{sub-sectiondiv:class=sIndent}{code:language=javascript}
plugins.agent.setVisible(true);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{builder-showtbody:permissionid=editspeak-String}{tr:id=seename}{td}*Also see*\\{sub-section:speak-String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:speak-String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edith6.speak{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}speak{span}{span}\(message){span}{td}{tr}{tr:id=linkprs}{td}*External linksParameters*\\{sub-section:speak-String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:speak-String_link|trigger=none}{sub-section}div:class=sIndent}\{[String]} message
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:speak-String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:speak-String_sam|trigger=none}{code:language=javascript}
plugins.agent.speak('hello nerd');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}