{{tag>event ranger}}

{{htmlmetatags>metatag-keywords=(pac3, wiki, event, collide)
metatag-description=(Triggers based on distance.)
metatag-og:title=(Ranger | Event)
metatag-og:description=(Triggers based on distance.)
}}
====== Ranger ======
Triggers based on distance. Ranger casts a ray starting at the location of the parent model, in the direction of the red positional arrow. <span code>[[#distance|Distance]]</span> is the %%max%% length of the ray. <span code>[[#compare|Compare]]</span> is the distance you want to compare to using an [[#operator]]. The event shows a distance preview while editing.

<wrap shadow>{{:part:event:ranger:ranger.png?direct}}</wrap>


===== Operator =====
<block box compact>
== above ==
Ranger set to <span code>above</span> will hide attached parts when the distance to an object is higher than <span code>[[#compare]]</span>. 
</block>

<block box compact>
== below ==
Ranger set to <span code>below</span> will hide attached parts when the distance to an object is lower than <span code>[[#compare]]</span>. 
</block>

<block box>
{{fa>info?color=#3bb0ff&fw&lg}} This behavior can be inverted by using <span code>[[:part:event#invert]]</span>.
</block>

===== Arguments =====
^name^type^description^
|**{{anchor:distance}}[[#distance]]** | number | The %%max%% length of the ray. Needs to be higher than <span code>[[#compare]]</span>. The actual value only matters when using <span code>[[#npcs_and_players_only]]</span> (BUG?). |
|**{{anchor:npcs_and_players_only}}[[#npcs_and_players_only]]** | boolean | Ignores world collision. Only triggers when a player or an NPC is detected. |
|**{{anchor:compare}}[[#compare]]**  | number | The number that you want to compare the distance to. |

===== Usage & Examples =====
<block box>
==== Basic usage ====
  - Add a dummy model to your outfit and attach the ranger event to it.
  - Use the dummy to set a direction of the ranger. (Red arrow means //forward//)
  - Enable [[:part:event#affect children only]] and attach other parts to the event.
</block>

<block box>
<block right 12em>
<wrap shadow nomargins> {{:part:event:ranger:event_ranger.png?direct|}} </wrap>
</block>
==== Simple ranger ====
Set <span code>[[#distance]]</span> to 200, <span code>[[#compare]]</span> to 100, operator to above, the event will trigger when an object appears closer than 100 units away from you.

<block box compact>
{{fa>fas fa-arrow-alt-circle-down?color=#7ab353&fw&lg}}  **Download:** {{:part:event:ranger:event_ranger.txt}}
</block>
</block>

===== Similar Events =====
  * [[:part:event:collide]]
  * [[:part:event:is_touching]]