Difference between revisions of "SetEnemy"

From GECK

m (Examples: fixing wrap-around)
(Use function template. Really fix wrapping by not including explanation in preformatted text.)
Line 1: Line 1:
=='''Description'''==
+
{{Function
 +
|origin = GECK1
 +
|summary = [[SetEnemy]] sets an enemy/neutral relationship between two factions. It is not called on a reference.
 +
|arguments = {{FunctionArgument
 +
    |Name = Faction1
 +
  }}{{FunctionArgument
 +
    |Name = Faction2
 +
  }}{{FunctionArgument
 +
    |Name = F1toF2Flag
 +
    |Value = 0,1
 +
    |Optional = y
 +
  }}{{FunctionArgument
 +
    |Name = F2toF1Flag
 +
    |Value = 0,1
 +
    |Optional = y
 +
  }}
 +
}}
 +
==Examples==
  
'''SetEnemy''' Sets an enemy/neutral relationship between two factions. It is not called on a reference.
+
SetEnemy BrotherhoodSteelFaction EnclaveFaction
 +
This makes the BrotherhoodSteelFaction and the EnclaveFaction Enemies of each other
 +
SetEnemy BrotherhoodSteelFaction EnclaveFaction 1 0
 +
This makes the BrotherhoodSteelFaction Neutral to EnclaveFaction but EnclaveFaction will treat BrotherhoodSteelFaction as an Enemy
  
=='''Syntax'''==
+
==Notes==
 
+
SetEnemy ''Faction1'' ''Faction2'' ''F1toF2Flag (0/1) (optional)'' ''F2toF1Flag  (0/1) (optional)''
+
 
+
=='''Examples'''==
+
 
+
SetEnemy BrotherhoodSteelFaction EnclaveFaction              ; this makes the BrotherhoodSteelFaction and the EnclaveFaction Enemies of each other
+
SetEnemy BrotherhoodSteelFaction EnclaveFaction 1 0          ; this makes the BrotherhoodSteelFaction Neutral to EnclaveFaction
+
                                                              ; but EnclaveFaction will treat BrotherhoodSteelFaction as an Enemy
+
 
+
=='''Notes'''==
+
 
*The values for the flag mean:
 
*The values for the flag mean:
 
**0 = Enemy (default)
 
**0 = Enemy (default)
 
**1 = Neutral
 
**1 = Neutral
  
 
+
==See Also==
=='''See Also'''==
+
 
* [[SetAlly]]
 
* [[SetAlly]]
 
=='''Reference'''==
 
None provided.
 
<!-- [[SetFactionCombatReaction_Reference|List of functions that use SetFactionCombatReaction]]  (wiki) -->
 
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Faction Functions]]
 
[[Category:Faction Functions]]

Revision as of 20:50, 12 February 2009

A function included in the GECK version 1.1.0.36.

Description

SetEnemy sets an enemy/neutral relationship between two factions. It is not called on a reference.

Syntax

SetEnemy Faction1 Faction2 F1toF2Flag{0,1} F2toF1Flag{0,1}

Examples

SetEnemy BrotherhoodSteelFaction EnclaveFaction

This makes the BrotherhoodSteelFaction and the EnclaveFaction Enemies of each other

SetEnemy BrotherhoodSteelFaction EnclaveFaction 1 0

This makes the BrotherhoodSteelFaction Neutral to EnclaveFaction but EnclaveFaction will treat BrotherhoodSteelFaction as an Enemy

Notes

  • The values for the flag mean:
    • 0 = Enemy (default)
    • 1 = Neutral

See Also

Personal tools