MappinSystem
Documents the MappinSystem class and its functions.
NOT DOCUMENTED
We currently don't have information on how these functions work. They are being documented here for visibility.
Invoking MappinSystem
To invoke the mappin system, use the following Global function:
ms = Game.MappinSystem()
Sub-functions
ChangeMappinVariant
ChangeMappinVariant(id : NewMappinID, newVariant : gamedataMappinVariant);
DebugDiscoverAllPoiMappins
DebugDiscoverAllPoiMappins();
GetMappins
GetMappins(targetType : gamemappinsMappinTargetType, out mappins : array:MappinEntry);
GetPointOfInterestMappinSavedState
GetPointOfInterestMappinSavedState(hash : Uint32, out mappinPhase : Uint16, out mappinVariant : Uint16, out active : Bool) : Bool;
GetQuestMappinPosition
GetQuestMappinPosition(mappinHash : Uint32, out position : Vector3) : Bool;
GetQuestMappinPositionsByObjective
GetQuestMappinPositionsByObjective(objectiveHash : Uint32, out positions : array:Vector3) : Bool;
OnAreaEntered
OnAreaEntered(evt : ref:AreaEnteredEvent);
OnAreaExited
OnAreaExited(obj : wref:GameObject, triggerId : EntityID);
OnAreaTypeChanged
OnAreaTypeChanged(entityID : EntityID, areaType : CName);
RegisterFastTravelMappin
RegisterFastTravelMappin(data : MappinData, fastTravelData : ref:FastTravelPointData) : NewMappinID;
RegisterGrenadeMappin
RegisterGrenadeMappin(data : MappinData, grenadeObject : wref:GameObject) : NewMappinID;
RegisterMappin
RegisterMappin(data : MappinData, position : Vector4) : NewMappinID;
RegisterMappinWithObject
RegisterMappinWithObject(data : MappinData, object : wref:GameObject, optional slotName : CName, optional offset : Vector3) : NewMappinID;
RegisterRemotePlayerMappin
RegisterRemotePlayerMappin(data : MappinData, playerObject : wref:GameObject) : NewMappinID;
RegisterVehicleMappin
RegisterVehicleMappin(data : MappinData, object : wref:GameObject, optional slotName : CName, optional offset : Vector3) : NewMappinID;
SetMappinActive
SetMappinActive(id : NewMappinID, active : Bool);
SetMappinDebugCaption
SetMappinDebugCaption(id : NewMappinID, caption : String);
SetMappinPosition
SetMappinPosition(id : NewMappinID, position : Vector4);
SetMappinScriptData
SetMappinScriptData(id : NewMappinID, scriptData : ref:MappinScriptData);
SetMappinTrackingAlternative
SetMappinTrackingAlternative(mappinID : NewMappinID, targetMappinID : NewMappinID);
UnregisterMappin
UnregisterMappin(id : NewMappinID);
UpdateCurrentLocationName
UpdateCurrentLocationName(locationName : String, isNewLocation : Bool);