Differences

This shows you the differences between two versions of the page.

--- 4rpl:commands:getmissionobjectivestate [2021/01/08 11:01] – external edit 127.0.0.1
+++ 4rpl:commands:getmissionobjectivestate [2023/06/25 16:57] – revised description removed confusing material regarding true/false Karsten75
@@ Line 1: / Line 1: @@
 ~~NOTOC~~
-<=[[4rpl:start| Index]]
+<=[[4rpl:start| Index]] \\
+<=[[4rpl:start#mission| Mission]]
 ====== GetMissionObjectiveState ======
@@ Line 6: / Line 7: @@
 ===== Description =====
-Gets state (1 or 0) of a mission objective. Mission objectives are defined in the game menu of a mission. When criteria is met, the objective is set to 1.
+Gets state (1, -1 or 0) of a mission objective. Mission objectives are defined in the game menu of a mission.
-When the mission objective is failed, -1 is returned
+Mission objectives range from 0 to 5 and are  enumerated in [[acquiremissionobjective]].
-Mission objectives are referenced by a number, 0-5.
- = "Nullify Enemies"\\
+States are:
- = "Activate Totems"\\
+  ? 0
-= "Reclaim"\\
+  : Objective not (yet) achieved
-= "Survive" \\
+  ? 1
-= "Collect Items"\\
+  : Objective achieved
-= "Custom"
+  ? -1
+  : Objective failed
 ===== Examples =====
@@ Line 20: / Line 25: @@
 GetMissionObjectiveState(5) ->customObjState
 </code>
+==== See Also ====
+[[AcquireMissionObjective]]
 <=[[4rpl:start| Index]]

Knuckle Cracker Wiki