Published using Google Docs
BattlePhaze EnterExit Documentation
Updated automatically every 5 minutes

BattlePhaze Enter Exit Documentation



Contents

Demo Scenes

Setup Guide

creating a addon module

Contact Details


Luke Dooly

Email | doolanl208@gmail.com

Discord | dooly123#0001 | https://discord.gg/bEzmAbC


Demo Scenes

The demo scene for entering and exiting is located at: BattlePhaze/BattlePhazeEnterExit/BattlePhazeEnterExitDemo/Demo Scene/

The Demo scene contains an example of a player and vehicle interaction example.

To spawn a Car Press F1.

The Demo player is set up like this in the demo.

The Demo Car is setup like this.

Setup Guide


The player controller requires the components : BattlePhazeEnterExitPlayer & a Collider to be detected by the Vehicle Controller. Once you have added the BattlePhazeEnterExitPlayer be sure to assign the photonview, The local Camera is just a spot for the camera, really the camera & behaviour state should be handled by you, however i have put those there to help you along in development.

Note: on entering the vehicle the root of the player will be disabled.

For the vehicle the setup process is a bit longer, required components are, photonview,BattlePhazeEnterExit & a collider for entering and exiting.

From there the BattlePhaze Enter Exit options are:

Main

Auto Slow Down : slows the vehicle down upon exiting by reducing the Rigidbody’s velocity.

Slow Down Ratio : the reduction in velocity

Enter Key: Enter the vehicle Key

Exit Key: Exiting the vehicle Key

Time Between Entering and exiting: the time between being able to enter the vehicle again.

Enter Exit Addon Module: modular support for third party’s and addons.

Seat

After setting up these the seats can be setup.

Take ownership : Gives ownership of the vehicle to that seat.

Name: the seats name can be useful for callbacks

Chair Location: the chair that gets enabled and disabled (normally the components that get enabled with the chair)

Exit Location: Exit location of the player.

Once you have done this setup, make sure to press the Setup error check.

Pressing the Setup Error check will assist with insuring that the components are setup correctly.


creating a addon module


I have laid the groundwork for creating addons with abstract classes. This is useful for building support for all kinds of things. The image below shows the current Abstract calls.

| BattlePhaze |