SetActivatorToPlayer: Difference between revisions

SetActivatorToPlayer (view source)

180 bytes added , 3 July 2022

no edit summary

1,584

edits

@@ Line 1: / Line 1: @@
 {{Template:ACSWarning}}
-int '''SetActivatorToPlayer'''(int playernumber)
+bool '''SetActivatorToPlayer''' (int ''playernumber'')
-==Usage==
+== Usage ==
-Sets the activator of the script to a specific player.  This functions replaces using SetActivator with a Player Pointer (AAPTR_PLAYERx) and allows any player to be set as the activator, not just the first 8 players.
+Sets the activator of the script to a specific player. This functions replaces using SetActivator with a Player Pointer (AAPTR_PLAYERx) and allows any player to be set as the activator, not just the first 8 players.
-==Parameters==
+=== Parameters ===
-* playernumber: Number of the player to set as the activator.
+* ''playernumber'': Number of the player to set as the activator.
+=== Return value ===
+Returns true if the player is valid and was set as the activator; false otherwise.
+== Examples ==
+{{noexamples}}
+[[Category: ACS functions]]