Child pages
  • agent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}{sub-section}\\ {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}{tr:id=des}{td}{sub-section:x_des|trigger=button|text=}{sub-section}{sub-section:x_des|trigger=none|class=sIndent}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClient

servoy sSummary12%30%58%height: 30px;3Property SummaryGets or sets the x position of the agent.Gets or sets the y position of the agent.

servoy sSummary12%30%58%height: 30px;3Methods SummaryvoidSets the size of the balloon.voidSets a new image for the agent.voidSets the location of the agent.voidShow/hides the agent.voidMakes the agent speak.

propertyservoy sDetail2100%height:30px2Property Detailsxname

x

dessIndent
Gets or sets the x position of the agent.
{sub-section}{td}{tr}{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}{tr:id=des}{td}{sub-section:y_des|trigger=button|text=}{sub-section}{sub-section:y_des|trigger=none|class=sIndent}
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowyname

y

dessIndent
Gets or sets the y position of the agent.
{sub-section}{td}{tr}{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|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}{tr:id=des}{td}{sub-section:setBalloonSize_des|trigger=button|text=}{sub-section}{sub-section:setBalloonSize_des|trigger=none|class=sIndent}
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailssetBalloonSizename

setBalloonSize(width, height)

dessIndent
Sets the size of the balloon.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setBalloonSize_snc|trigger=button|text=}{sub-section}{sub-section:setBalloonSize_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setBalloonSize_prs|trigger=button|text=}{sub-section}{sub-section:setBalloonSize_prs|trigger=none|class=sIndent}\{[Number]} width \{[Number]} height {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setBalloonSize_ret|trigger=button|text=}{sub-section}{sub-section:setBalloonSize_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setBalloonSize_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setBalloonSize_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setBalloonSize_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setBalloonSize_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setBalloonSize_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setBalloonSize_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|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}{tr:id=des}{td}{sub-section:setImageURL_des|trigger=button|text=}{sub-section}{sub-section:setImageURL_des|trigger=none|class=sIndent}
prs

Parameters

sIndentwidth ;height ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowsetImageURLname

setImageURL(url)

dessIndent
Sets a new image for the agent.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setImageURL_snc|trigger=button|text=}{sub-section}{sub-section:setImageURL_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setImageURL_prs|trigger=button|text=}{sub-section}{sub-section:setImageURL_prs|trigger=none|class=sIndent}\{[String]} url {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setImageURL_ret|trigger=button|text=}{sub-section}{sub-section:setImageURL_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setImageURL_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setImageURL_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setImageURL_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setImageURL_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setImageURL_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setImageURL_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|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}{tr:id=des}{td}{sub-section:setLocation_des|trigger=button|text=}{sub-section}{sub-section:setLocation_des|trigger=none|class=sIndent}
prs

Parameters

sIndenturl ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowsetLocationname

setLocation(x, y)

dessIndent
Sets the location of the agent.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setLocation_snc|trigger=button|text=}{sub-section}{sub-section:setLocation_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setLocation_prs|trigger=button|text=}{sub-section}{sub-section:setLocation_prs|trigger=none|class=sIndent}\{[Number]} x \{[Number]} y {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setLocation_ret|trigger=button|text=}{sub-section}{sub-section:setLocation_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setLocation_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocation_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setLocation_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocation_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setLocation_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocation_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|class=node}{tr:id=name}{td}h6.setVisible{td}{tr}{tr:id=sig}{td}{span: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){span}{td}{tr}{tr:id=des}{td}{sub-section:setVisible_des|trigger=button|text=}{sub-section}{sub-section:setVisible_des|trigger=none|class=sIndent}Show/hides the agent.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setVisible_snc|trigger=button|text=}{sub-section}{sub-section:setVisible_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setVisible_prs|trigger=button|text=}{sub-section}{sub-section:setVisible_prs|trigger=none|class=sIndent}\{[Boolean]} visible {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setVisible_ret|trigger=button|text=}{sub-section}{sub-section:setVisible_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setVisible_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setVisible_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setVisible_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setVisible_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setVisible_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setVisible_sam|trigger=none}{code:language=javascript} plugins.agent.setVisible(true); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=speak|class=node}{tr:id=name}{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}{td}{tr}{tr:id=des}{td}{sub-section:speak_des|trigger=button|text=}{sub-section}{sub-section:speak_des|trigger=none|class=sIndent}Makes the agent speak.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:speak_snc|trigger=button|text=}{sub-section}{sub-section:speak_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:speak_prs|trigger=button|text=}{sub-section}{sub-section:speak_prs|trigger=none|class=sIndent}\{[String]} message {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:speak_ret|trigger=button|text=}{sub-section}{sub-section:speak_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:speak_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:speak_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:speak_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:speak_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:speak_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:speak_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}
prs

Parameters

sIndentx ;y ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowsetVisiblename

setVisible(visible)

dessIndent
Show/hides the agent.
prs

Parameters

sIndentvisible ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
speakname

speak(message)

dessIndent
Makes the agent speak.
prs

Parameters

sIndentmessage ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow