Difference between revisions of "OpenTeammateContainer"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Cipscis
(Added little information about optional parameter)
imported>Cipscis
(Updated to use template, added more information about parameter)
Line 1: Line 1:
=='''Description'''==
{{Function
'''OpenTeammateContainer''' brings up the "teammate" version of the container menu, which allows the player to freely swap inventory with the actor this is called on.
|origin = GECK1
 
|summary = [[OpenTeammateContainer]] brings up the "teammate" version of the container menu, which allows the player to freely swap inventory with the actor this is called on.  If the optional "IgnoreTeammate" parameter is set to 1, the function will work on all Actors.  Otherwise, it will only work on Actors that are the player's teammate.
=='''Syntax'''==
|referenceType = Actor
ActorRef.OpenTeammateContainer Integer (optional)
|arguments = {{FunctionArgument
    |Name = IgnoreTeammate
    |Type = int
    |Optional = y
  }}
|example = BuddyRef.OpenTeammateContainer 1


Opens BuddyRef's "teammate container", regardless of whether or not BuddyRef is the player's teammate
}}
=='''Notes'''==
=='''Notes'''==
*The optional parameter is set to 0 by default
*The "IgnoreTeammate" parameter is set to 0 by default
*If the optional parameter is set to 0, nothing seems to happen


=='''See Also'''==
*[[SetPlayerTeammate]]
*[[GetPlayerTeammate]]
*[[GetPlayerTeammateCount]]
[[Category:Functions]]
[[Category:Functions]]

Revision as of 17:45, 12 February 2009

< [[::Category:Functions|Category:Functions]]

A function included in the GECK version 1.1.0.36.

Description

OpenTeammateContainer brings up the "teammate" version of the container menu, which allows the player to freely swap inventory with the actor this is called on. If the optional "IgnoreTeammate" parameter is set to 1, the function will work on all Actors. Otherwise, it will only work on Actors that are the player's teammate.

Syntax

[help]
Actor.OpenTeammateContainer IgnoreTeammate:int

Example

BuddyRef.OpenTeammateContainer 1

Opens BuddyRef's "teammate container", regardless of whether or not BuddyRef is the player's teammate

Notes

  • The "IgnoreTeammate" parameter is set to 0 by default

See Also