Package ifxpool [Client Modules]

客户端--3D特效模块(仅用于2D/3D混合渲染) More...

Functions
def	create_play_once_fx
	创建播放一次特效，播完自动回收 需要restart才能播放
def	create_play_loop_fx
	创建循环播放特效，需要主动销毁
def	play_once_fx_async
	异步加载特效，加载完成后自动播放，播放完成后自动销毁
def	del_fx
	销毁某个特效
def	release_fx
	释放某个特效，并不销毁，放回特效池
def	get_fx_obj
	根据id获取特效
def	destroy
	特效池的销毁.

---

Detailed Description

客户端--3D特效模块(仅用于2D/3D混合渲染)

---

Function Documentation

def ifxpool.create_play_once_fx	(		filename,
			layer_id = None
	)

创建播放一次特效，播完自动回收
需要restart才能播放

Parameters:

filename	特效文件名
layer_id	3D场景所在的world2d层次id

Return values:

id

特效id编号

def ifxpool.create_play_loop_fx	(		filename,
			layer_id = None
	)

创建循环播放特效，需要主动销毁

Parameters:

filename	特效文件名
layer_id	3D场景所在的world2d层次id

Return values:

id

特效id编号

def ifxpool.play_once_fx_async	(		filename,
			layer_id = None,
			async_callback = None,
			async_args = ()
	)

异步加载特效，加载完成后自动播放，播放完成后自动销毁

Parameters:

filename	特效文件名
layer_id	3D场景所在的world2d层次id
async_callback	: function 异步加载后的回调函数，async_callback(async_args)
async_args	: 回调函数的参数，如果是tuple/list，则回调函数有多个参数；如果是其他对象，则只返回一个参数；如果为()，则不返回参数

Return values:

id

特效id编号

def ifxpool.del_fx

(

fx_id )

销毁某个特效

Parameters:

fx_id

特效id编号

Return values:

bool	成功返回True，失败返回False

def ifxpool.release_fx	(		fx_id,
			unregister_flag = True
	)

释放某个特效，并不销毁，放回特效池

Parameters:

fx_id	特效id编号
unregister_flag	内部使用，保持默认值True则可

Return values:

bool	成功返回True，失败返回False

def ifxpool.get_fx_obj

(

fx_id )

根据id获取特效

Parameters:

fx_id

特效id编号

Return values:

iworld3d.fx3d

特效对象

def ifxpool.destroy

(

)

特效池的销毁.