Child pages
  • agent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{div: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 AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR{div} {div:id=description}{div}\\ {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}{tr:id=name}{td}h6.x{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}{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=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} width \{[Number]} height {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} plugins.agent.setBalloonSize(width,height) {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setImageURL-String}{tr:id=name}{td}h6.setImageURL{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setImageURL{span}{span}\(url){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} url {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} plugins.agent.setImageURL("url") {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setLocation-Number_Number}{tr:id=name}{td}h6.setLocation{td}{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=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} x \{[Number]} y {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} plugins.agent.setLocation(100,100); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setVisible-Boolean}{tr:id=name}{td}h6.setVisible{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setVisible{span}{span}\(visible){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} visible {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} plugins.agent.setVisible(true); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=speak-String}{tr:id=name}{td}h6.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=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} message {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} plugins.agent.speak('hello nerd'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowyname

y

dessIndent
Gets or sets the y position of the agent.
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.
prs

Parameters

sIndentwidth ;height ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowsetImageURLname

setImageURL(url)

dessIndent
Sets a new image for the agent.
prs

Parameters

sIndenturl ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setLocationname

setLocation(x, y)

dessIndent
Sets the location of the agent.
prs

Parameters

sIndentx ;y ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setVisiblename

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