CFrobDoor - Revision history

Greebo: /* Spawnargs */

2009-03-27T10:49:06Z

Spawnargs

← Older revision		Revision as of 10:49, 27 March 2009
Line 21:		Line 21:
	* '''lock_peer_N''' (entity name) Specifies the name of another door which should be locked and unlocked along with this one. Multiple spawnargs are allowed, as long as their prefix is 'lock_peer'.		* '''lock_peer_N''' (entity name) Specifies the name of another door which should be locked and unlocked along with this one. Multiple spawnargs are allowed, as long as their prefix is 'lock_peer'.

	* '''pickable''' (1/0) If set to 1, is pickable by the player.
	* '''used_by_N''' (entity name) Contains an entity name (of keys) that can unlock/lock this door. Multiple used_by keys are possible by numbering them (like <tt>used_by_3</tt>).		* '''used_by_N''' (entity name) Contains an entity name (of keys) that can unlock/lock this door. Multiple used_by keys are possible by numbering them (like <tt>used_by_3</tt>).

Line 28:		Line 27:
	* '''loss_double_open''' (float) Soundprop: Acoustical loss applied to sounds going thru a set of double doors when one is open and the other is closed (defaults to 1 dB).		* '''loss_double_open''' (float) Soundprop: Acoustical loss applied to sounds going thru a set of double doors when one is open and the other is closed (defaults to 1 dB).

	* '''lock_picktype''' (string) This is a sequence of characters defining the lockpick types which need to be used on this door. For instance, 'bs' means that the player must use the "bent" lockpick ('b') and the "snake" lockpick ('s') - in this order - to pick this lock. It's also possible to define a star "*", which matches all lockpick types.
	* '''lock_pins''' (string) Defines the number of samples per pin to be created for this lock, example: "56" will create two patterns, one with 5 samples, the other with 6 samples. The minimum is 5.

	* '''snd_lockpick_pin_NN''' (soundshader) Defines the sample sound for the pin with NN being in the range 00..14. The number must have a leading zero in it (e.g. '02').
	* '''snd_lockpick_pin_sweetspot''' (soundshader) Defines the sweet spot sound to be inserted into a pattern.
	* '''snd_lockpick_lock_picked''' (soundshader) Is played when the entire lock is successfully picked.
	* '''snd_lockpick_pin_success''' (soundshader) Is played when a single pin is successfully picked.
	* '''snd_lockpick_pin_fail''' (soundshader) Is played when the player fails to pick a pin.
	* '''snd_lockpick_pick_wrong''' (soundshader) Is played when the user either attempts to use the wrong lockpick type or the door is not locked or already picked.
	* '''snd_wrong_key''' (soundshader) The sound to be played when the player is using the wrong key on this door.		* '''snd_wrong_key''' (soundshader) The sound to be played when the player is using the wrong key on this door.

Greebo: /* Script Events */

2009-03-25T09:55:53Z

Script Events

← Older revision		Revision as of 09:55, 25 March 2009
Line 44:		Line 44:
	: The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does.		: The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does.
	: Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.		: Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.
	~~; scriptEvent float IsPickable();~~
	~~: Returns true (nonzero) if this door is pickable.~~
	; scriptEvent entity GetDoorhandle();		; scriptEvent entity GetDoorhandle();
	: Returns the handle entity of this door. Can return NULL (== $null_entity)		: Returns the handle entity of this door. Can return NULL (== $null_entity)

Greebo: /* CFrobDoor */

2009-03-19T13:19:15Z

CFrobDoor

← Older revision		Revision as of 13:19, 19 March 2009
Line 4:		Line 4:
	See also the [[Doors]] article for a tutorial approach.		See also the [[Doors]] article for a tutorial approach.

	This is the most sophisticated ~~BinaryFrobMover~~. A door extends the functionality by a lot of code to open/close visportals, controlling double doors, attaching handles, lockpicking and peer relationships to other doors.		This is the most sophisticated [[CBinaryFrobMover]]. A door extends the functionality by a lot of code to open/close visportals, controlling double doors, attaching handles, lockpicking and peer relationships to other doors.

	Note: A door works closely together with the CFrobDoorHandle class, but it can function as well without a handle.		Note: A door works closely together with the [[CFrobDoorHandle]] class, but it can function as well without a handle.

	=== Spawnargs ===		=== Spawnargs ===

Greebo: /* Spawnargs */

2009-03-19T13:14:25Z

Spawnargs

← Older revision		Revision as of 13:14, 19 March 2009
Line 28:		Line 28:
	* '''loss_double_open''' (float) Soundprop: Acoustical loss applied to sounds going thru a set of double doors when one is open and the other is closed (defaults to 1 dB).		* '''loss_double_open''' (float) Soundprop: Acoustical loss applied to sounds going thru a set of double doors when one is open and the other is closed (defaults to 1 dB).

	* '''lock_pins''' (string) Defines the number of pin patterns to be created for this lock.		* '''lock_picktype''' (string) This is a sequence of characters defining the lockpick types which need to be used on this door. For instance, 'bs' means that the player must use the "bent" lockpick ('b') and the "snake" lockpick ('s') - in this order - to pick this lock. It's also possible to define a star "*", which matches all lockpick types.
	* '''lockpick_pin_''' (???) (greebo: TODO)		* '''lock_pins''' (string) Defines the number of samples per pin to be created for this lock, example: "56" will create two patterns, one with 5 samples, the other with 6 samples. The minimum is 5.
	* '''lock_picktype''' (string) This is a sequence of characters defining the lockpick types which need to be used on this door. For instance, 'bs' means that the player must use the "bent" lockpick ('b') and the "snake" lockpick ('s') - in this order - to pick this lock.
	* ~~'''lockpick_bar''' (entity name) The entity~~ which ~~should be used as~~ lockpick ~~bar. This is the moveable part which wiggles around when the player is picking the lock~~.
	* '''~~lockpick_bar_bind_flag~~''' (~~1/0~~) ~~If set~~ to ~~'1'~~, ~~the entity specified in 'lockpick_bar'~~ will ~~be bound to this door. Default is '1'.~~
	* '''lockpick_rotate''' (angles) The full rotation angles the lockpick bar should rotate while picking. This is the full rotation, the ~~rotation per lock pin is automatically calculated~~.
	* '''lockpick_translate''' (vector) The ~~full translation the lockpick bar should move while picking. This is the full translation, the translation per lock pin~~ is ~~automatically calculated~~.

	* '''~~lockpick_lock_picked~~''' (soundshader) (~~greebo: TODO: Needs to be changed to use the snd_ prefix~~).		* '''snd_lockpick_pin_NN''' (soundshader) Defines the sample sound for the pin with NN being in the range 00..14. The number must have a leading zero in it (e.g. '02').
	* '''~~lockpick_pin_success~~''' (soundshader)~~(greebo: TODO: Needs~~ to be ~~changed to use~~ the ~~snd_ prefix~~).		* '''snd_lockpick_pin_sweetspot''' (soundshader) Defines the sweet spot sound to be inserted into a pattern.
	* '''~~lockpick_pin_fail~~''' (soundshader) ~~(greebo: TODO: Needs to be changed~~ to ~~use the snd_ prefix)~~.		* '''snd_lockpick_lock_picked''' (soundshader) Is played when the entire lock is successfully picked.
	* '''~~lockpick_pick_wrong~~''' (soundshader) ~~(greebo: TODO: Needs to be changed~~ to use the ~~snd_ prefix)~~.		* '''snd_lockpick_pin_success''' (soundshader) Is played when a single pin is successfully picked.
			* '''snd_lockpick_pin_fail''' (soundshader) Is played when the player fails to pick a pin.
	* '''snd_wrong_key''' (~~sound shader~~) The sound to be played when the player is using the wrong key on this door.		* '''snd_lockpick_pick_wrong''' (soundshader) Is played when the user either attempts to use the wrong lockpick type or the door is not locked or already picked.
			* '''snd_wrong_key''' (soundshader) The sound to be played when the player is using the wrong key on this door.

	=== Script Events ===		=== Script Events ===

Greebo: /* Spawnargs */

2008-08-21T16:43:32Z

Spawnargs

← Older revision		Revision as of 16:43, 21 August 2008
Line 22:		Line 22:

	* '''pickable''' (1/0) If set to 1, is pickable by the player.		* '''pickable''' (1/0) If set to 1, is pickable by the player.
	* '''~~used_by~~''' (~~list~~) Contains ~~a list of~~ entity ~~names~~ (of keys) that unlock/lock this door~~, separated~~ by ~~semicola ';'~~.		* '''used_by_N''' (entity name) Contains an entity name (of keys) that can unlock/lock this door. Multiple used_by keys are possible by numbering them (like <tt>used_by_3</tt>).

	* '''loss_open''' (float) Soundprop: Acoustical loss applied to sounds going thru the door when it is open (default 1 dB).		* '''loss_open''' (float) Soundprop: Acoustical loss applied to sounds going thru the door when it is open (default 1 dB).

Greebo: categorised

2008-06-30T07:44:05Z

categorised

← Older revision		Revision as of 07:44, 30 June 2008
Line 56:		Line 56:
	Most of the setup work is done in the virtual override of CBinaryFrobMover::PostSpawn(). The CFrobDoor::PostSpawn() override sets up the double doors, binds the doorhandles and sets up the lock_ and open_peers.		Most of the setup work is done in the virtual override of CBinaryFrobMover::PostSpawn(). The CFrobDoor::PostSpawn() override sets up the double doors, binds the doorhandles and sets up the lock_ and open_peers.

	{{~~coding~~}}{{editing}}		{{sdk}} {{editing}}

SneaksieDave: Attempt at clarifying "bind" directional confusion

2008-06-26T16:56:18Z

Attempt at clarifying "bind" directional confusion

← Older revision		Revision as of 16:56, 26 June 2008
Line 9:		Line 9:

	=== Spawnargs ===		=== Spawnargs ===
	* '''auto_setup_door_handles''' (1/0) If set to 1 (which is the default), the door will automatically search for bound door handles and set them up.		* '''auto_setup_door_handles''' (1/0) If set to 1 (which is the default), the door will automatically search for bound door handles and set them up. (Bound handles contain a "bind" keypair indicating the door, e.g., "bind" "door1")
	* '''auto_setup_double_door''' (1/0) If set to 1 (which is the default), the door will automatically search for double doors and add it to the peers list. The sub-spawnargs 'auto_setup_double_door_open_peer', 'auto_setup_double_door_lock_peer' and 'auto_setup_double_door_frob_peer' define which peer lists are affected.		* '''auto_setup_double_door''' (1/0) If set to 1 (which is the default), the door will automatically search for double doors and add it to the peers list. The sub-spawnargs 'auto_setup_double_door_open_peer', 'auto_setup_double_door_lock_peer' and 'auto_setup_double_door_frob_peer' define which peer lists are affected.
	** '''auto_setup_double_door_open_peer''' (1/0) This is only active if 'auto_setup_double_door' == '1'. If this is set to 1, the double door auto-setup code will automatically add the double door as open_peer.		** '''auto_setup_double_door_open_peer''' (1/0) This is only active if 'auto_setup_double_door' == '1'. If this is set to 1, the double door auto-setup code will automatically add the double door as open_peer.

Greebo: added auto-double door spawnargs

2008-06-25T17:15:37Z

added auto-double door spawnargs

← Older revision		Revision as of 17:15, 25 June 2008
Line 10:		Line 10:
	=== Spawnargs ===		=== Spawnargs ===
	* '''auto_setup_door_handles''' (1/0) If set to 1 (which is the default), the door will automatically search for bound door handles and set them up.		* '''auto_setup_door_handles''' (1/0) If set to 1 (which is the default), the door will automatically search for bound door handles and set them up.
	* '''auto_setup_double_door''' (1/0) If set to 1 (which is the default), the door will automatically search for double doors and add it as open_peer ~~and~~ lock_peer.		* '''auto_setup_double_door''' (1/0) If set to 1 (which is the default), the door will automatically search for double doors and add it to the peers list. The sub-spawnargs 'auto_setup_double_door_open_peer', 'auto_setup_double_door_lock_peer' and 'auto_setup_double_door_frob_peer' define which peer lists are affected.
			** '''auto_setup_double_door_open_peer''' (1/0) This is only active if 'auto_setup_double_door' == '1'. If this is set to 1, the double door auto-setup code will automatically add the double door as open_peer.
			** '''auto_setup_double_door_lock_peer''' (1/0) This is only active if 'auto_setup_double_door' == '1'. If this is set to 1, the double door auto-setup code will automatically add the double door as lock_peer.
			** '''auto_setup_double_door_frob_peer''' (1/0) This is only active if 'auto_setup_double_door' == '1'. If this is set to 1, the double door auto-setup code will automatically add the double door as frob_peer.

	* '''door_handle''' (entity name) Set to the entity name that is a handle for this door. (Note: this is not required if '''auto_setup_door_handles''' is set to true (in which case the handle just needs to be bound to the door).		* '''door_handle''' (entity name) Set to the entity name that is a handle for this door. (Note: this is not required if '''auto_setup_door_handles''' is set to true (in which case the handle just needs to be bound to the door).

Greebo: New page: == CFrobDoor == The corresponding entityDef is '''atdm:mover_door''' See also the Doors article for a tutorial approach. This is the most sophisticated BinaryFrobMover. A door extend...

2008-06-22T14:31:38Z

New page: == CFrobDoor == The corresponding entityDef is '''atdm:mover_door''' See also the Doors article for a tutorial approach. This is the most sophisticated BinaryFrobMover. A door extend...

New page

== CFrobDoor ==
The corresponding entityDef is '''atdm:mover_door'''

See also the [[Doors]] article for a tutorial approach.

This is the most sophisticated BinaryFrobMover. A door extends the functionality by a lot of code to open/close visportals, controlling double doors, attaching handles, lockpicking and peer relationships to other doors.

Note: A door works closely together with the CFrobDoorHandle class, but it can function as well without a handle.

=== Spawnargs ===
* '''auto_setup_door_handles''' (1/0) If set to 1 (which is the default), the door will automatically search for bound door handles and set them up.
* '''auto_setup_double_door''' (1/0) If set to 1 (which is the default), the door will automatically search for double doors and add it as open_peer and lock_peer.

* '''door_handle''' (entity name) Set to the entity name that is a handle for this door. (Note: this is not required if '''auto_setup_door_handles''' is set to true (in which case the handle just needs to be bound to the door).
* '''door_handle_bind_flag''' (1/0) If set to "1", the entity specified in 'door_handle' will be bound to this door. Default is "1".

* '''open_peer_N''' (entity name) Specifies the name of another door which should be opened and closed along with this one. Multiple spawnargs are allowed, as long as their prefix is 'open_peer'.
* '''lock_peer_N''' (entity name) Specifies the name of another door which should be locked and unlocked along with this one. Multiple spawnargs are allowed, as long as their prefix is 'lock_peer'.

* '''pickable''' (1/0) If set to 1, is pickable by the player.
* '''used_by''' (list) Contains a list of entity names (of keys) that unlock/lock this door, separated by semicola ';'.

* '''loss_open''' (float) Soundprop: Acoustical loss applied to sounds going thru the door when it is open (default 1 dB).
* '''loss_closed''' (float) Soundprop: Acoustical loss applied to sounds going thru the door when it is completely closed (default 15 dB).
* '''loss_double_open''' (float) Soundprop: Acoustical loss applied to sounds going thru a set of double doors when one is open and the other is closed (defaults to 1 dB).

* '''lock_pins''' (string) Defines the number of pin patterns to be created for this lock.
* '''lockpick_pin_''' (???) (greebo: TODO)
* '''lock_picktype''' (string) This is a sequence of characters defining the lockpick types which need to be used on this door. For instance, 'bs' means that the player must use the "bent" lockpick ('b') and the "snake" lockpick ('s') - in this order - to pick this lock.
* '''lockpick_bar''' (entity name) The entity which should be used as lockpick bar. This is the moveable part which wiggles around when the player is picking the lock.
* '''lockpick_bar_bind_flag''' (1/0) If set to '1', the entity specified in 'lockpick_bar' will be bound to this door. Default is '1'.
* '''lockpick_rotate''' (angles) The full rotation angles the lockpick bar should rotate while picking. This is the full rotation, the rotation per lock pin is automatically calculated.
* '''lockpick_translate''' (vector) The full translation the lockpick bar should move while picking. This is the full translation, the translation per lock pin is automatically calculated.

* '''lockpick_lock_picked''' (soundshader) (greebo: TODO: Needs to be changed to use the snd_ prefix).
* '''lockpick_pin_success''' (soundshader)(greebo: TODO: Needs to be changed to use the snd_ prefix).
* '''lockpick_pin_fail''' (soundshader) (greebo: TODO: Needs to be changed to use the snd_ prefix).
* '''lockpick_pick_wrong''' (soundshader) (greebo: TODO: Needs to be changed to use the snd_ prefix).

* '''snd_wrong_key''' (sound shader) The sound to be played when the player is using the wrong key on this door.

=== Script Events ===

; scriptEvent void OpenDoor(float Master);
: The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does.
: Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.
; scriptEvent float IsPickable();
: Returns true (nonzero) if this door is pickable.
; scriptEvent entity GetDoorhandle();
: Returns the handle entity of this door. Can return NULL (== $null_entity)

=== C++ Methods and Events ===
Most of the setup work is done in the virtual override of CBinaryFrobMover::PostSpawn(). The CFrobDoor::PostSpawn() override sets up the double doors, binds the doorhandles and sets up the lock_ and open_peers.

{{coding}}{{editing}}