iInventoryTriggerFactory Struct Reference

This interface is implemented by the trigger that fires when a certain inventory gets some entity. More...

#include <tools/triggers.h>

Inheritance diagram for iInventoryTriggerFactory:

List of all members.

Public Member Functions
virtual void	SetChildEntityParameter (const char *child_entity)=0
	Set the name of the entity to watch for.
virtual void	SetEntityParameter (const char *entity, const char *tag=0)=0
	Set the name of the entity containing the pcinventory property class on which this trigger will fire.

---

Detailed Description

This interface is implemented by the trigger that fires when a certain inventory gets some entity.

You can query this interface from the trigger factory if you want to manually control this factory as opposed to loading its definition from an XML document.

The predefined name of this trigger type is 'cel.triggers.inventory'.

This trigger sends out 'child' parameter to the reward (containing the name of the entity that was added or removed).

In XML, factories recognize the following attributes on the 'fireon' node:

• entity: the name of the entity that contains the pcinventory property class.
• entity_tag: optional tag used to find the right property class from the entity.
• child_entity: the name of the entity to watch for. If this is not given then you will get triggere whenever something is added or removed from the inventory.

Definition at line 213 of file triggers.h.

---

Member Function Documentation

virtual void iInventoryTriggerFactory::SetChildEntityParameter

(

const char *

child_entity

)

[pure virtual]

Set the name of the entity to watch for.

If this is not given then you will get triggered whenever something is added or removed from the inventory.

Parameters:

child_entity

is the name of the entity or a parameter (starts with '$').

virtual void iInventoryTriggerFactory::SetEntityParameter	(	const char *	entity,
		const char *	tag = 0
	)		[pure virtual]

Set the name of the entity containing the pcinventory property class on which this trigger will fire.

Parameters:

entity	is the name of the entity or a parameter (starts with '$').
tag	is the optional tag of the entity or a parameter (starts with '$').

---

The documentation for this struct was generated from the following file:

• tools/triggers.h