Difference between revisions of "Logic merchant relay"

From Obsidian Conflict Wiki
Jump to: navigation, search
m (Undo revision 348 by OulibOricc (Talk))
(Basicly created the entire page - Gjs)
Line 1: Line 1:
 
{{oc_ent}}
 
{{oc_ent}}
{{stub}}
+
 
 +
{{oc ent}}
 +
== Entity Description ==
 +
 
 +
An entity that allows the use of points to "purchase" objects or trigger a entity.
 +
 
 +
== Keyvalues ==
 +
 
 +
* '''targetname <target_source>'''
 +
 
 +
Defines the name that other entities refer to this entity by.
 +
 
 +
* '''Start Disabled? <0/1> '''
 +
 
 +
* '''Is Shared? <0/1> '''
 +
 
 +
Can all players chip in to buy this?
 +
 
 +
* '''Announce Cash Needed? <0/1>'''
 +
 
 +
Tell the players how much cash they still need to purchase?
 +
 
 +
* '''Purchase Sound <String>'''
 +
 
 +
Name of the GameSound entry for the sound to play on purchase. Also supports direct .wav filenames.
 +
 
 +
* '''Cost of Purchase <float>'''
 +
 
 +
* '''Max Points to take ( Shared Only ) <float>'''
 +
 
 +
How many points should be taken from the player when they input purchase? 0 Means as much as needed
 +
 
 +
* '''Name of Purchase <String>'''
 +
 
 +
Name of the purchase, which will appear in relay messages from this entity.
 +
 
 +
 
 +
==Inputs==
 +
 
 +
* '''Kill'''
 +
 
 +
Removes this entity from the world.
 +
 
 +
* '''KillHierarchy'''
 +
 
 +
Removes this entity and all its children from the world.
 +
 
 +
* '''AddOutput <string>'''
 +
 
 +
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
 +
 
 +
Format: <key> <value>
 +
 
 +
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>
 +
 
 +
* '''FireUser1-4'''
 +
 
 +
Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.
 +
 
 +
* '''Enable'''
 +
 
 +
Enables this entity.
 +
 
 +
* '''Disable'''
 +
 
 +
Disables this entity.
 +
 
 +
* '''Purchase'''
 +
 
 +
Sends the activator's cash amount to this entity(right?).
 +
 
 +
* '''SetPurchaseCost <float>'''
 +
 
 +
Sets the cost to make a purchase.
 +
 
 +
* '''SetPurchaseName <string>'''
 +
 
 +
Sets the name of the purchase, which will appear in relay messages from this entity.
 +
 
 +
 
 +
==Outputs==
 +
 
 +
* '''OnCashReduced'''
 +
 
 +
* '''OnDisabled'''
 +
 
 +
Fired when this entity is disabled.
 +
 
 +
* '''OnNotEnoughCash'''
 +
 
 +
Fired when an a player attempts to purchase but lacks the required cash.
 +
 
 +
* '''OnPurchased'''
 +
 
 +
Fired when the player successfully makes a purchase.
 +
 
 +
 
 +
* '''OnUser1-4'''
 +
 
 +
Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.
 +
 
 +
!activator = activator

Revision as of 09:26, 9 December 2009

Entity.png This Page contains informations about an Obsidian Conflict Entity, which means it is only availible for Obsidian Conflict or rather in that form it is explained.
Entity.png This Page contains informations about an Obsidian Conflict Entity, which means it is only availible for Obsidian Conflict or rather in that form it is explained.

Entity Description

An entity that allows the use of points to "purchase" objects or trigger a entity.

Keyvalues

  • targetname <target_source>

Defines the name that other entities refer to this entity by.

  • Start Disabled? <0/1>
  • Is Shared? <0/1>

Can all players chip in to buy this?

  • Announce Cash Needed? <0/1>

Tell the players how much cash they still need to purchase?

  • Purchase Sound <String>

Name of the GameSound entry for the sound to play on purchase. Also supports direct .wav filenames.

  • Cost of Purchase <float>
  • Max Points to take ( Shared Only ) <float>

How many points should be taken from the player when they input purchase? 0 Means as much as needed

  • Name of Purchase <String>

Name of the purchase, which will appear in relay messages from this entity.


Inputs

  • Kill

Removes this entity from the world.

  • KillHierarchy

Removes this entity and all its children from the world.

  • AddOutput <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.

Format: <key> <value>

Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>

  • FireUser1-4

Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.

  • Enable

Enables this entity.

  • Disable

Disables this entity.

  • Purchase

Sends the activator's cash amount to this entity(right?).

  • SetPurchaseCost <float>

Sets the cost to make a purchase.

  • SetPurchaseName <string>

Sets the name of the purchase, which will appear in relay messages from this entity.


Outputs

  • OnCashReduced
  • OnDisabled

Fired when this entity is disabled.

  • OnNotEnoughCash

Fired when an a player attempts to purchase but lacks the required cash.

  • OnPurchased

Fired when the player successfully makes a purchase.


  • OnUser1-4

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.

!activator = activator