| KBEngine |
KBEngine模块
KBEngine模块提供了逻辑脚本层访问实体的部分, 以及当前space的数据等等。类
| Entity |
成员函数
| def login( username, password ): |
| def createAccount( username, password ): |
| def reloginBaseapp(): |
| def player( ): |
| def resetPassword(username): |
| def bindAccountEmail( emailaddress ): |
| def newPassword( oldpassword, newpassword ): |
| def findEntity( entityID ): |
| def getSpaceData( key ): |
回调函数
属性
| component | 只读 string |
| entities | Entities |
| entity_uuid | uint64 |
| entity_id | int32 |
| spaceID | int32 |
成员函数文档
def login( username, password ):
功能说明：
登录账号到KBEngine服务端。
注意：如果插件与UI层使用事件交互模式，在UI层不要直接调用，请触发一个"login"事件给插件，事件附带数据username和password。
登录账号到KBEngine服务端。
注意：如果插件与UI层使用事件交互模式，在UI层不要直接调用，请触发一个"login"事件给插件，事件附带数据username和password。
参数：
| username | string，用户名。 |
| password | string，密码。 |
def createAccount( username, password ):
功能说明：
请求向KBEngine服务端创建一个登录账号。
注意：如果插件与UI层使用事件交互模式，在UI层不要直接调用，请触发一个"createAccount"事件给插件，事件附带数据username和password。
请求向KBEngine服务端创建一个登录账号。
注意：如果插件与UI层使用事件交互模式，在UI层不要直接调用，请触发一个"createAccount"事件给插件，事件附带数据username和password。
参数：
| username | string，用户名。 |
| password | string，密码。 |
def reloginBaseapp( ):
功能说明：
请求重登录到KBEngine服务端(通常在掉线之后希望更及时的连接到服务端并继续控制服务端角色时使用)。
注意：如果插件与UI层使用事件交互模式，在UI层不要直接调用，请触发一个"reloginBaseapp"事件给插件，事件附带数据为空。
请求重登录到KBEngine服务端(通常在掉线之后希望更及时的连接到服务端并继续控制服务端角色时使用)。
注意：如果插件与UI层使用事件交互模式，在UI层不要直接调用，请触发一个"reloginBaseapp"事件给插件，事件附带数据为空。
def player( ):
功能说明：
获得当前客户端所控制的实体。
获得当前客户端所控制的实体。
返回：
| Entity，返回控制的实体, 如果不存在(如：未能连接到服务端)则返回空。 |
def resetPassword( username ):
功能说明：
请求loginapp重置账号的密码, 服务端将会向该账号绑定的邮箱发送一封重置密码邮件(通常是忘记密码功能使用)。
请求loginapp重置账号的密码, 服务端将会向该账号绑定的邮箱发送一封重置密码邮件(通常是忘记密码功能使用)。
参数：
| username | string，用户名。 |
def bindAccountEmail( emailaddress ):
功能说明：
请求baseapp绑定账号的email地址。
请求baseapp绑定账号的email地址。
参数：
| emailaddress | string，邮箱地址。 |
def newPassword( oldpassword, newpassword ):
功能说明：
请求设置账号的新密码。
请求设置账号的新密码。
参数：
| oldpassword | string，旧密码。 |
| newpassword | string，新密码。 |
def findEntity( entityID ):
功能说明：
通过实体的ID查找实体的实例对象。
通过实体的ID查找实体的实例对象。
参数：
| entityID | int32，实体ID。 |
返回：
| Entity，存在返回实体实例，不存在返回空。 |
def getSpaceData( key ):
参数：
| key | string，一个字符串关键字。 |
返回：
| string，指定key的字符串数据。 |
回调函数文档
属性文档
component
说明：
这是正运行在当前脚本环境的组件。（至今为止）可能值有'cell', 'base', 'client', 'database', 'bot' 和 'editor'。
这是正运行在当前脚本环境的组件。（至今为止）可能值有'cell', 'base', 'client', 'database', 'bot' 和 'editor'。
entities
说明：
entities是一个字典对象，包含当前进程上所有的实体。
entities是一个字典对象，包含当前进程上所有的实体。
类型：
| Entities |
entity_uuid
说明：
实体的uuid，改ID与实体本次登录绑定。当使用重登陆功能时服务端会与此ID进行比对，判断合法性。
实体的uuid，改ID与实体本次登录绑定。当使用重登陆功能时服务端会与此ID进行比对，判断合法性。
entity_id
说明：
当前客户端所控制的实体的ID。
当前客户端所控制的实体的ID。
spaceID