62 | {% block search_results %}
63 |
64 | {% block page %}
65 | {{ page.content|safe }}
66 | {% endblock %}
67 |
68 | {% endblock %}
69 |
70 |
32 | {% block book_sidebar %}
33 |
45 | {% block search_input %}{% endblock %}
46 | {% block book_summary %}
47 |
50 | {% endblock %}
51 | {% endblock %}
52 |
53 |
54 |
55 | {% block book_body %}
56 |
88 |
89 |
95 |
57 | {% block book_inner %}
58 | {% include "website/header.html" %}
59 |
60 |
73 |
74 | {% block book_navigation %}
75 | {% if page.previous and page.previous.path %}
76 |
77 |
78 |
79 | {% endif %}
80 | {% if page.next and page.next.path %}
81 |
82 |
83 |
84 | {% endif %}
85 | {% endblock %}
86 | {% endblock %}
87 |
61 |
71 | {% endblock %}
72 | 
13 |
14 | To add an interface we have to go into **Class Settings**
15 |
16 | From here we click on **Add**, inside Interfaces and search for FactionAgentInterface
17 |
18 | ### Getting and Setting the Faction
19 |
20 | Factions require your actor to define how to get and set a faction. That can be done overriding **GetFaction** and **SetFaction**.
21 |
22 | A common implementation would be to have a **variable** (of type *"Faction"*), and then return it with GetFaction and set it with SetFaction:
23 |
24 | 
25 |
26 | 
27 |
28 | ### Factions in Controllers
29 |
30 | Sometimes you may want a controller to share a faction with its controlled pawn or character.
31 |
32 | This process is exactly the same as before, except that instead of getting and setting a variable, we will get and set the faction from our pawn.
33 |
34 | ## C++
35 |
36 | ### Adding the interface
37 |
38 | Add **IFactionAgentInterface** to any Actor:
39 |
40 | 
41 |
42 | ### Getting and Setting the Faction
43 |
44 | In order for the system to read our faction, we need to provide a getter and a setter. The returned variable depends on what your code needs.
45 |
46 | 
47 |
48 | A common case is to have a Faction variable exposed to the editor *(like in the example)*. You could also set dependent factions by getting another actor's Faction *(e.g Inside a controller)*.
49 |
50 | **Using Factions without Actors**
51 |
52 | Non-actor objects can also have factions, but they can't be called though normal API functions for simplicity. This means that, for example, a component could have a faction, but only Actors can be checked for attitude.
53 |
54 | This is useful for modularizing Actor logic inside components, distributing faction logic.
55 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/Docs/documentation/usage.md:
--------------------------------------------------------------------------------
1 | # Usage
2 |
3 | All settings can be edited from **Project Settings -> Game -> Factions** tab.
4 |
5 | 
6 |
7 |
8 |
9 | ## Factions
10 |
11 | Factions settings are defined by right and left areas.
12 |
13 | **At the left** you have a list of all factions, with a little search box in case you have more than you can deal with.
14 |
15 | **At the right** you will find all the properties of a selected faction (which was selected by just clicking on it on the list).
16 |
17 | 
18 |
19 |
20 |
21 | You can also rename factions by double clicking on them.
22 |
23 | 
24 |
25 |
26 |
27 | All Faction information can be read on runtime too:
28 |
29 | 
30 |
31 |
32 |
33 | ## Relations
34 |
35 | Relations define how will two factions interact to each other.
36 |
37 | In this example, Brotherhood and Triggermen are enemies:
38 |
39 | 
40 |
41 | By default there are three possible attitudes: **Hostile**, **Neutral** and **Friendly**
42 |
43 |
--------------------------------------------------------------------------------
/Docs/downloads/book.epub:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/PipeRift/FactionsExtension/4105d44b1ef6dfa0a0e79238046c0b3cb112b756/Docs/downloads/book.epub
--------------------------------------------------------------------------------
/Docs/downloads/book.mobi:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/PipeRift/FactionsExtension/4105d44b1ef6dfa0a0e79238046c0b3cb112b756/Docs/downloads/book.mobi
--------------------------------------------------------------------------------
/Docs/downloads/book.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/PipeRift/FactionsExtension/4105d44b1ef6dfa0a0e79238046c0b3cb112b756/Docs/downloads/book.pdf
--------------------------------------------------------------------------------
/Docs/downloads/implementation.md:
--------------------------------------------------------------------------------
1 | # Implementation
2 |
3 | ## Blueprints
4 |
5 | *Check the **[Test Project](https://mega.nz/#!JMowlKCA!wZv-L6oNSJCwDw1CUbTFyjPOXvd6viB-QLgK-u36xtY)** for a detailed example*
6 |
7 | ### Adding the interface
8 |
9 | For an actor to have a faction, we need to add a FactionAgentInterface.
10 | This will allow the system to set and get the current interface.
11 |
12 |