Difference between revisions of "MDE Scripting: Snippets"

From Nomad DB
Line 1: Line 1:
{{Page_MDE}}
+
==Get the [[MDE Scripting: Player Entity|Player]] entity==
==Get the [[MDE Scripting: Entities#Player|Player]] entity==
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
local Player = game.game:GetActivePlayer()
 
local Player = game.game:GetActivePlayer()
 
</syntaxhighlight>
 
</syntaxhighlight>
  
*[[MDE Scripting: GetActivePlayer|game.game:GetActivePlayer]]
+
* [[MDE Scripting: GetActivePlayer|game.game:GetActivePlayer]]
 +
* [[MDE Scripting: Player Entity|Player Entity]]
  
  
==Get the [[MDE Scripting: Entities#Player|Player's]] current [[MDE Scripting: Entities#Vehicle|Vehicle]] entity==
+
==Get the [[MDE Scripting: Player Entity|Player's]] current vehicle entity==
 
Returns the vehicle entity the player is currently sitting in.
 
Returns the vehicle entity the player is currently sitting in.
  
Line 37: Line 37:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
*[[MDE Scripting: GetActivePlayer|game.game:GetActivePlayer]]
+
* [[MDE Scripting: GetActivePlayer|game.game:GetActivePlayer]]
*[[MDE Scripting: GetOwner|Player:GetOwner]]
+
* [[MDE Scripting: GetOwner|Player:GetOwner]]
*[[MDE Scripting: GetOwnerSceneObject|Player:GetOwnerSceneObject]]
+
* [[MDE Scripting: GetOwnerSceneObject|Player:GetOwnerSceneObject]]
 +
* [[MDE Scripting: Player Entity|Player Entity]]
 +
* [[MDE Scripting: Car Entity|Car Entity]]
 +
* [[MDE Scripting: Boat Entity|Boat Entity]]
 +
* [[MDE Scripting: Motorcycle Entity|Motorcycle Entity]]
  
  
==Get the [[MDE Scripting: Entities#Vehicle|Vehicle's]] current [[MDE Scripting: Entities#Motorcycle|Motorcycle]] component==
+
==Get the vehicle's current [[MDE Scripting: Entities#Motorcycle|Motorcycle]] component==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Tip
 
!Tip
|You need to [[MDE Scripting: Snippets#Get the Player's current Vehicle entity|Get the Player's current Vehicle entity]] first.
+
|You need to [[MDE Scripting: Snippets#Get the Player's current vehicle entity|Get the Player's current vehicle entity]] first.
 
|}
 
|}
  
Line 52: Line 56:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
*[[MDE Scripting: Snippets#Get the Player's current Vehicle entity|Get the Player's current Vehicle entity]]
+
* [[MDE Scripting: Snippets#Get the Player's current Vehicle entity|Get the Player's current Vehicle entity]]
*[[MDE Scripting: GetComponent|Vehicle:GetComponent]]
+
* [[MDE Scripting: GetComponent|Vehicle:GetComponent]]
*[[MDE Scripting: C_RuntimeMotorcycleComponent|C_RuntimeMotorcycleComponent]]
+
* [[MDE Scripting: C_RuntimeMotorcycleComponent|C_RuntimeMotorcycleComponent]]
 +
* [[MDE Scripting: Player Entity|Player Entity]]
 +
* [[MDE Scripting: Car Entity|Car Entity]]
 +
* [[MDE Scripting: Boat Entity|Boat Entity]]
 +
* [[MDE Scripting: Motorcycle Entity|Motorcycle Entity]]
  
 +
 +
{{Page_MDE}}
 +
__FORCETOC__
  
  
Line 61: Line 72:
 
[[Category:MDE Scripting]]
 
[[Category:MDE Scripting]]
 
[[Category:MDE Snippets]]
 
[[Category:MDE Snippets]]
 
__FORCETOC__
 

Revision as of 23:07, 18 November 2020

Get the Player entity

local Player = game.game:GetActivePlayer()


Get the Player's current vehicle entity

Returns the vehicle entity the player is currently sitting in.

local function GetPlayerCurrentVehicle()
    local Player = game.game:GetActivePlayer()

    if not Player then
        return nil
    end

    local Vehicle = Player:GetOwner()

    if not Vehicle then
        Vehicle = Player:GetOwnerSceneObject()
    end

    if not Vehicle then
        return nil
    end

    return Vehicle
end
local Vehicle = GetPlayerCurrentVehicle() -- returns the vehicle scene object


Get the vehicle's current Motorcycle component

Tip You need to Get the Player's current vehicle entity first.
local Motorcycle = Vehicle:GetComponent("C_RuntimeMotorcycleComponent")