RemovePlayerClothes: Difference between revisions

Latest revision as of 09:09, 4 November 2020

	This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
	Please use removePedClothes instead.

This function is used to remove the current clothes of a certain type on a player. It will remove them if the clothesTexture and clothesModel aren't specified, or if they match the current clothes on that slot.

Syntax

bool removePlayerClothes ( player thePlayer, int clothesType, [ string clothesTexture, string clothesModel ] )

Required Arguments

thePlayer: The player whose clothes you want to remove.
clothesType: A integer representing the clothes slot/type to remove. See the clothes catalog.

Optional Arguments

clothesTexture: A string determining the clothes texture that will be removed. See the clothes catalog.
clothesModel: A string determining the clothes model that will be removed. See the clothes catalog.

Returns

This function returns true if the clothes were successfully removed from the player, false otherwise.

Example

This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.

function addHelmetOnEnter ( vehicle, seat, jacked )
    if ( getVehicleID ( vehicle ) == 522 ) then            -- if its a nrg
        addPlayerClothes ( source, "moto", "moto", 16 )    -- add the helmet
    end
end
addEventHandler ( "onPlayerVehicleEnter", root, addHelmetOnEnter )

function addHelmetOnExit ( vehicle, seat, jacked )
    if ( getVehicleID ( vehicle ) == 522 ) then            -- if its a nrg
        removePlayerClothes ( source, 16, "moto", "moto" ) -- remove that helmet
    end
end
addEventHandler ( "onPlayerVehicleExit", root, addHelmetOnExit )

@@ Line 1: / Line 1: @@
 __NOTOC__
-This function is used to remove the current clothes of a certain type on a [[player]].
+{{Server client function}}
-Note: removes if the clothesTexture and clothesModel aren't specified, or if they match the current clothes on that slot.
+{{Deprecated|removePedClothes}}
+This function is used to remove the current clothes of a certain type on a [[player]]. It will remove them if the clothesTexture and clothesModel aren't specified, or if they match the current clothes on that slot.
 ==Syntax==
@@ Line 10: / Line 12: @@
 ===Required Arguments===
 *'''thePlayer''': The [[player]] whose clothes you want to remove.
-*'''clothesType''': A integer representing the clothes slot/type to remove.
+*'''clothesType''': A integer representing the clothes slot/type to remove. See the [[CJ Clothes|clothes catalog]].
 ===Optional Arguments===
-*'''clothesTexture''': A string determining the clothes texture that will be removed.
+*'''clothesTexture''': A string determining the clothes texture that will be removed. See the [[CJ Clothes|clothes catalog]].
-*'''clothesModel''': A string determining the clothes model that will be removed.
+*'''clothesModel''': A string determining the clothes model that will be removed. See the [[CJ Clothes|clothes catalog]].
 ==Returns==
-This function returns 'true' if the clothes were successfully removed from the player, 'false' otherwise.
+This function returns ''true'' if the clothes were successfully removed from the player, ''false'' otherwise.
 ==Example==
-This example adds a 'moto' helmet to a player wen he gets on a nrg bike, and removes it when he gets off.
+This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.
 <syntaxhighlight lang="lua">
-addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
+function addHelmetOnEnter ( vehicle, seat, jacked )
-function onPlayerEnterVehicle ( vehicle, seat, jacked )
+    if ( getVehicleID ( vehicle ) == 522 ) then            -- if its a nrg
-  if ( getVehicleID ( vehicle ) == 522 ) then -- if its a nrg
+        addPlayerClothes ( source, "moto", "moto", 16 )    -- add the helmet
-    addPlayerClothes ( source, "moto", "moto", 16 ) -- add the helmet
+    end
-  end
 end
+addEventHandler ( "onPlayerVehicleEnter", root, addHelmetOnEnter )
-addEventHandler ( "onPlayerExitVehicle", root, "onPlayerExitVehicle" )
+function addHelmetOnExit ( vehicle, seat, jacked )
-function onPlayerExitVehicle ( vehicle, seat, jacked )
+    if ( getVehicleID ( vehicle ) == 522 ) then            -- if its a nrg
-  if ( getVehicleID ( vehicle ) == 522 ) then -- if its a nrg
+        removePlayerClothes ( source, 16, "moto", "moto" ) -- remove that helmet
-    removePlayerClothes ( source, 16 ) -- remove the helmet
+    end
-  end
 end
+addEventHandler ( "onPlayerVehicleExit", root, addHelmetOnExit )
 </syntaxhighlight>
 ==See Also==
 {{Clothes and body functions}}