RemovePlayerClothes: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
{{Deprecated}}
{{Deprecated}}
Please use [[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.
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.



Revision as of 21:31, 20 April 2011

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.


Please use 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

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", getRootElement(), 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", getRootElement(), addHelmetOnExit )

See Also