RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
set_player_interaction_locked

Differences

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

Link to this comparison view

Next revision		Previous revision
set_player_interaction_locked [2017/04/14 14:41] – external edit 127.0.0.1set_player_interaction_locked [2021/04/21 18:34] (current) – justin
Line 2: Line 2:
 ---- ----
  
-Locks or unlocks the player's ability to interact with objects and characters.+Locks or unlocks the player's ability to interact with [[object|objects]] or speak to [[character|characters]] in the scene.
  
 +====Signature:====
 <code python> <code python>
-set_player_interaction_locked(true)+set_player_interaction_locked(is_locked)
 </code> </code>
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|true|Description.|[[String]]|Yes|+|is_locked|State of player interaction.|[[Boolean]]|Yes|
  
 ====Example:==== ====Example:====
-<code python> +<code bauxite> 
-set_player_interaction_locked(true)+set_player_interaction_locked(true);
 </code> </code>
-//Results://+//Results:// The player is no longer able to interact with any [[object|objects]] or [[character|characters]] until their interaction is re-enabled.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Lock/Unlock Player Interaction** function to ...+Use the **Lock/Unlock Player Interaction** function to prevent the player from interacting with [[object|objects]] during a cutscene. This will typically be used in conjunction with [[set_player_movement_locked|Lock/Unlock Player Movement]].
 </WRAP> </WRAP>
  
Line 30: Line 31:
  
 <WRAP half column> <WRAP half column>
-====Visual Demo:==== 
-{{:wiki:set_player_interaction_locked_demo.gif?nolink|}} 
 </WRAP> </WRAP>
 </WRAP> </WRAP>
set_player_interaction_locked.1492206116.txt.gz · Last modified: 2017/04/14 14:41 by 127.0.0.1

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki