Child pages
  • agent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
{hidden}
Wiki Markup
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:padding=0px|width=80px}{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:padding=0px|width=80px}{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:padding=0px|width=100%}{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|text=|trigger=button}{sub-section}{sub-section:x_des|trigger=none|class=sIndent}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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:x_sam|trigger=none}{code:language=javascript}


HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#x
Gets or sets the x position of the agent.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#y
Gets or sets the y position of the agent.

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setBalloonSize(width, height)
Sets the size of the balloon.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setImageURL(url)
Sets a new image for the agent.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setLocation(x, y)
Sets the location of the agent.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setVisible(visible)
Show/hides the agent.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#speak(message)
Makes the agent speak.

HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idx
classnode
Table Row (tr)
idname
Table Cell (td)
x
Table Row (tr)
iddes
Table Cell (td)
Gets or sets the x position of the agent.
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idy
classnode
Table Row (tr)
idname
Table Cell (td)
y
Table Row (tr)
iddes
Table Cell (td)
Gets or sets the y position of the agent.
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//move the agent diagonaly
plugins.agent.x = plugins.agent.x-10;
plugins.agent.y = plugins.agent.y-10;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idsetBalloonSize
classnode
Table Row (tr)
idname
Table Cell (td)
setBalloonSize
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setBalloonSize
Span
stylefloat: left;
idiets
(width, height)
Table Row (tr)
iddes
Table Cell (td)
Sets the size of the balloon.
Table Row (tr)
idprs
Table Cell (td)
Parameters
width
height
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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|text=|trigger=button}{sub-section}{sub-section:setImageURL_des|trigger=none|class=sIndent}Sets a new image for the agent.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setImageURL_snc|text=|trigger=button}{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|text=|trigger=button}{sub-section}{sub-section:setImageURL_prs|trigger=none|class=sIndent}url {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setImageURL_ret|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setImageURL_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetImageURL
classnode
Table Row (tr)
idname
Table Cell (td)
setImageURL
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setImageURL
Span
stylefloat: left;
idiets
(url)
Table Row (tr)
iddes
Table Cell (td)
Sets a new image for the agent.
Table Row (tr)
idprs
Table Cell (td)
Parameters
url
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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|text=|trigger=button}{sub-section}{sub-section:setLocation_des|trigger=none|class=sIndent}Sets the location of the agent.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setLocation_snc|text=|trigger=button}{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|text=|trigger=button}{sub-section}{sub-section:setLocation_prs|trigger=none|class=sIndent}x y {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setLocation_ret|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setLocation_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetLocation
classnode
Table Row (tr)
idname
Table Cell (td)
setLocation
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setLocation
Span
stylefloat: left;
idiets
(x, y)
Table Row (tr)
iddes
Table Cell (td)
Sets the location of the agent.
Table Row (tr)
idprs
Table Cell (td)
Parameters
x
y
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{sub-section}{sub-section:setVisible_prs|trigger=none|class=sIndent}visible {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setVisible_ret|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setVisible_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetVisible
classnode
Table Row (tr)
idname
Table Cell (td)
setVisible
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setVisible
Span
stylefloat: left;
idiets
(visible)
Table Row (tr)
iddes
Table Cell (td)
Show/hides the agent.
Table Row (tr)
idprs
Table Cell (td)
Parameters
visible
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{sub-section}{sub-section:speak_prs|trigger=none|class=sIndent}message {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:speak_ret|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:speak_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idspeak
classnode
Table Row (tr)
idname
Table Cell (td)
speak
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
speak
Span
stylefloat: left;
idiets
(message)
Table Row (tr)
iddes
Table Cell (td)
Makes the agent speak.
Table Row (tr)
idprs
Table Cell (td)
Parameters
message
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

plugins.agent.speak('hello nerd');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)