战神引擎玩家对象的函数接口
1．函数接口：function GetBagItemCount(const ItemName: string) : Integer;
功能描述：查询当前背包中指定物品个数
函数参数：物品名
函数返回值：返回个数，0为背包中无此物品（注意输入的物品名称正确）
脚本调用示例：
var
ItemName : string;
ItemNum : Integer;
begin
ItemName := ‘屠龙’;
ItemNum := This_Player.GetBagItemCount(ItemName);
end;
2． 函数接口：function DelAllThisItem(const ItemName: string):Integer;
功能描述：删除背包中所有指定名称的物品
函数参数：物品名
函数返回值：返回删除了多少个
3． 函数接口：function Give(const ItemName: string; ItemCount: Integer): Boolean;
功能描述：给玩家发放指定奖励到玩家背包中，并给出系统消息
函数参数：物品名， 数量
函数返回值：返回是否成功得到奖励
脚本调用示例：
This_Player.Give(‘屠龙’, 3); //玩家在背包中得到3把屠龙，并发出系统消息
4． 函数接口：function Take(const ItemName: string; ItemCount: Byte):Integer;
功能描述：玩家背包中被取走指定数量的某物品
函数参数：物品名， 数量
函数返回值：返回是否成功（注意：如果数量不足,物品不会被取走，但返回False）
脚本调用示例：（判断玩家身上是否有10张野猪皮，有就取走野猪皮，给奖励）
if This_Player.GetBagItemCount(‘野猪皮’， 10) then
begin
This_Player.Take(‘野猪皮’, 10);
This_Player.Give(‘井中月’，1);
end;
5． 函数接口：procedure TakeBodyEquipByName(const ItemStr: string; TakeNum: integer);
功能描述：按名称删除人物身上道具
函数参数：物品名， 物品数量
函数返回值：无
6． 函数接口：function TakeBodyEquipByPos(const nPos: integer):string;
功能描述：按位置删除人物身上道具
函数参数：参数表示身上的哪个位置
函数返回值：返回删除物品的名称
7． 函数接口：procedure Flyto(const MapName: string; x: Word; y: Word)；功能描述：定点飞行
函数参数：地图名，x坐标，y坐标
函数返回值：无
8． 函数接口：procedure RandomFlyTo(const MapName : string)； 功能描述：飞到某地图的随机位置
函数参数：地图名
函数返回值：无
9． 函数接口：function MapName() : string;
功能描述：获取玩家当前所在地图的地图名称
函数参数：无
函数返回值：返回地图名称
注：
此函数配合玩家的My_x, My_y这两个坐标属性，就可以获得玩家当前的完
整地标属性。可以通过其他接口，将其他玩家传送到自己身边。
10． 函数接口：function IsCastle(): boolean;
功能描述：判断是否为沙巴克成员
函数参数：无
函数返回值：True为是沙巴克成员，False为否
11． 函数接口：procedure QuestInfo(const Msg: string);
功能描述：任务列表中显示
函数参数：当前任务显示
函数返回值：无
脚本调用示例：（具体见四、 脚本功能开发模板）
This_Player.QuestInfo(
'[日常]商人遇劫:\' +
'一个<[比奇省, 商人, 410, 342]/automove>在快进城时被抢劫\' +
'希望你帮忙收拾正在搬货的半兽人\' +
'任务：杀死<5个半兽人/c=red>\' +
'当前: 已杀N个半兽人\' +
'任务奖励：<经验100000/c=yellow>\' +
' <金币10000/c=yellow> \'
);
12． 函数接口：function GetV(const nTaskNo, nFieldNo: integer):Integer;
功能描述：读玩家的任务表中的某个任务变量
函数参数：任务编号，第几号任务变量（1－100）
函数返回值：取当前任务变量值
脚本调用示例：（具体见四、 脚本功能开发模板）
13． 函数接口：function SetV(const nTaskNo, nFieldNo, nValue: integer):Boolean;
功能描述：设置玩家的任务表中某个任务变量的值
函数参数：任务编号，变量编号，设置为何值
函数返回值：返回设置是否成功,如果变量编号不在1到100之间就会失败
脚本调用示例：（具体见四、 脚本功能开发模板）
14． 函数接口：function GetS(const nActNo, nFieldNo: integer):Integer;
功能描述：读玩家的活动表中的某个任务变量
函数参数：任务编号，第几号任务变量（1－50）
函数返回值：取当前任务变量值
脚本调用示例：（具体见四、 脚本功能开发模板）
15． 函数接口：function SetS(const nActNo, nFieldNo, nValue: integer):Boolean;
功能描述：设置玩家的任务表中某个任务变量的值
函数参数：任务编号，变量编号，设置为何值
函数返回值：返回设置是否成功,如果变量编号不在1到50之间就会失败
脚本调用示例：（具体见四、 脚本功能开发模板）
16． 函数接口：procedure PlayerDialog(const Msg: string);
功能描述：由玩家自己弹出的一个在左上角的对话框
函数参数：对话框中显示内容
函数返回值：无
脚本调用示例：
This_Player.PlayerDialog(‘你已进入付费地图！’);
17． 函数接口：procedure PlayerNotice(const Msg: string; const vColor: word);
功能描述：给玩家memo框提示（红色或其他颜色）
函数参数：下面框中显示的内容和颜色（0红，1绿，2蓝，3紫）
函数返回值：无
18． 函数接口：procedure CallOut(PsNpc: TObject; SpTime: integer; TimeOutProc : string);
功能描述：在NPC处设定延时执行事件
函数参数：npc对象，延迟时间，指定延时执行的函数标记
函数返回值：无
脚本调用示例：（具体见四、 脚本功能开发模板）
19． 函数接口：function IsGuildLord():Boolean;
功能描述：是否为行会老大
函数参数：无
函数返回值：是否
20． 函数接口：procedure GainExp(nExp: integer);
功能描述：玩家获取经验
函数参数：获取经验数
函数返回值：无
21． 函数接口：procedure IncPkpoint(const AddNum: integer);
功能描述：增加玩家pk值
函数参数：增加的值
函数返回值：无
22． 函数接口：procedure DecPkPoint(const X: integer);
功能描述：减少玩家pk值
函数参数：减少的值
函数返回值：无
23． 函数接口：function ChgHair(const Kind: Byte):Boolean;
功能描述：改变玩家发型
函数参数：发型的样式（待添加）
函数返回值：是否成功
24． 函数接口：function ChgSkillLv(const SkillName: string; ToLv: Byte; skillexp: integer);
功能描述：改变技能等级
函数参数：技能名称，要改变到的级别，改变到此等级时的经验。
函数返回值：无
脚本调用示例：
假设某战士玩家，原来的烈火等级为1，当前等级的技能经验50点
This_Player.ChgSkillLv(‘烈火剑法’,2, 10);
当前此玩家的烈火等级为2， 并且2级后的技能经验为10点
25． 函数接口：procedure DoDamageWeapon(const nDamage: integer);
功能描述：减少玩家手上武器的耐久
函数参数：减少的值
函数返回值：无
26． 函数接口：function AddGold(Value: integer):Boolean;
功能描述：增加玩家的金币数
函数参数：增加的值
函数返回值：增加是否成功
27． 函数接口：function DecGold(Value: integer):Boolean;
功能描述：减少玩家的金币数
函数参数：减少的值
函数返回值：减少是否成功
28． 函数接口：function BuildGuild(const GuildStr: string):Boolean;
功能描述：成立行会
函数参数：行会名
函数返回值：是否能成功建立该行会（如重名等情况就会失败）
29． 函数接口：function ReqCastleWar:Boolean;
功能描述：申请行会战
函数参数：无
函数返回值：是否可以申请
30． 函数接口：procedure AgreeMarry(Npc: Tobject);
功能描述：同意结婚
函数参数：npc对象
函数返回值：无
31． 函数接口：DisAgreeMarry();
功能描述：拒绝结婚
函数参数：无
函数返回值：无
/****************************新扩展接口*********************************/
32． 函数接口：function GetMyPositionInGuild() : Integer;
功能描述：获取当前人物与行会的关系
函数参数：无
函数返回值：-1为无行会,0表示只是会员,1表示为会长
脚本调用示例:
if This_Player.GetMyPositionInGuild() = 1 then
begin
//执行某些只有行会会长才能执行的操作
end;
33． 函数接口：function GetHeroBagItemCount(const ItemName: string): Integer;
功能描述：获取英雄背包中某物品的数量
函数参数: 物品名称
函数返回值：大于等于0表示为该物品的数量, -1为无英雄或未召唤
34． 函数接口：function TakeFromHeroBag(const ItemName: string; ItemCount: Byte): Boolean;
功能描述：从英雄背包取物品
函数参数：物品名称, 物品数量
函数返回值：true表示成功. false表示取走动作失败，或者无英雄或未召唤
35． 函数接口：function GetItemNameOnBody(const nPos : Integer): string;
功能描述：获取玩家身上某位置的装备名称
函数参数：人物身上的位置
函数返回值：返回当前位置上的装备名称,如果无装备则返回空字符串.
36． 函数接口：procedure GroupFly(const sTargetMap : string);
功能描述：由队长发出全体队员飞行到某地图的指令(如果不是队长,则使用此函数无效果)
函数参数：飞行的目标地图
函数返回值：无返回值
37． 函数接口：procedure ShiMenFly(const sTargetMap : string; mode: Integer);
功能描述：师门飞行，师傅和徒弟之间三种同飞方式
函数参数：sTargetMap是同飞的目标地图（随机某地点）
mode值表示飞行模式（要求一起飞行的人都在一张地图）：
1是师傅带所有徒弟一起飞；2是某个徒弟和自己师傅一起飞；
3是徒弟和自己师傅以及所有师兄一起飞;
函数返回值：无
38． 函数接口：procedure CoupleFly(const sTargetMap : string);
功能描述：夫妻飞行到目标地图,夫妻必须在同一地图
函数参数：飞行的目标地图
函数返回值：无
39． 函数接口：function UpGradeHeroSkill(const skill_idx: Integer; skill_exp : Integer) : Boolean;
功能描述：将指定的英雄技能升级若干经验
函数参数：英雄技能号, 升级经验
函数返回值：升级成功返回true. 英雄不存在或者没召唤英雄，或者升级失败都返回false
40． 函数接口：function GetHeroCardStudentPrize(): Integer;
功能描述：领取王师弟子奖励
函数参数：无
函数返回值：1表示领取成功,0表示已领取当前级别的奖励,
-1表示不是新手卡用户,-2表示背包空间不足
脚本调用示例:
This_Player.GetHeroCardStudentPrize();
注:如果需要该函数的返回值,也可以取它的值
41． 函数接口：function GetHeroCardTecherPrize(PsNpc: TObject) : Integer;
功能描述：领取王师教头奖励
函数参数：npc对象
函数返回值：1领取成功, 0当前级别已领取或弟子级别不够,
-1背包空间不够,-2级别不够50
脚本调用示例:
This_Player.GetHeroCardTeacherPrize(This_Npc);
注:这个里面需要调用This_Npc作为参数.
42． 函数接口：procedure TakeDiamond(TakeNum: integer; Npc: TObject);
功能描述：从玩家身上取走金刚石
函数参数：取走的金刚石数量, npc对象
函数返回值：无
43． 函数接口：procedure ChangeMapWithOths(const SeachMap: string);
功能描述：将自己和目标地图的所有玩家交换位置
函数参数：要交换的目标地图
函数返回值：无
注: 此函数的使用需要慎重,如果两张地图人数比较多则会较大影响效率
44． 函数接口：function TPlayer.CreateHero(heroName: string; hType, heroJob: Integer): Integer;
功能描述：创建英雄
函数参数：heroName 英雄名字；
hType 1代表白日门英雄、2代表酒馆英雄；
heroJob 英雄职业： 1、男战士， 2、男法师， 3、男道士，
4、女战士， 5 女法师， 6 女道士。
函数返回值：0 成功进行创建
-1 未能成功创建，已经有英雄；-2 未能成功创建，heroJob不是 1 到 6 之间；-3 未能成功创建，heroName有问题；-4 未能成功创建，hType不是 1 或者 2
45． 函数接口：procedure MakeDiamondWithYB(const Num : Integer );
功能描述：用元宝锻造金刚石
函数参数：Num 锻造元宝的数量（要在0到300之间，包含300）
函数返回值：无
46． 函数接口：procedure Donatediam(const InPutStr: string);
功能描述：赠送金刚石
函数参数：InputStr 要赠送的玩家及送出多少 格式为： 玩家名 金刚石数量 （如： Donatediam('GM01 100'）)
函数返回值：无
47． 函数接口：procedure AddLF(const nType, nNum : Integer);
功能描述：给玩家增加灵符
函数参数： nType灵符增加的类型,Num 灵符消耗数量
函数返回值：无
48． 函数接口：procedure DecLF(const nType, nNum : Integer);
功能描述：玩家消耗灵符
函数参数： nType灵符消耗的类型,Num 灵符消耗数量
函数返回值：无
注:这两个接口中,nType代表的意义是不一样的,DecLF中的nType表示灵符是因为什么消耗的,比如说圣殿灵符等…..而AddLF中的nType则表示该灵符本身属于哪种类型,例如限时灵符等……具体的类型怎么划分有待进一步确定.
49． 函数接口：procedure RequestGuildWar(const TargGuildStr: string);
功能描述：玩家申请行会战
函数参数： 申请进行对战的行会名称
函数返回值：无
- 上一篇：战神引擎玩家属性参数说明
- 下一篇：战神引擎NPC对象的函数接口